"create"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

A session represents an interactive conversation initiated by a user
through an API to engage with an  agent. It involves a series of
exchanges where the user sends queries or prompts, and the agent
responds with relevant information, actions, or assistance based on
the user’s input. The session persists for the duration of the
interaction, maintaining context and continuity to provide coherent
and meaningful responses throughout the conversation.Creates an agent
session.

Use this API to create an agent session.


Usage
=====

   oci generative-ai-agent-runtime session create [OPTIONS]


Required Parameters
===================

--agent-endpoint-id [text]

A unique ID for the endpoint.


Optional Parameters
===================

--description [text]

An optional description of the session.

--display-name [text]

The name of the session. A session names doesn’t have to be unique and
you can change the session name later.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export agent_endpoint_id=<substitute-value-of-agent_endpoint_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-agent-runtime/session/create.html#cmdoption-agent-endpoint-id

       oci generative-ai-agent-runtime session create --agent-endpoint-id $agent_endpoint_id
