"chat"
******

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


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

Chat on endpoint with provided messages.


Usage
=====

   oci generative-ai-agent-runtime agent-endpoint chat [OPTIONS]


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

--agent-endpoint-id [text]

A unique ID for the endpoint.


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

--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

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the *if-match* parameter to the value of the etag from a
previous GET or POST response for that resource. The resource will be
updated or deleted only if the etag you provide matches the resource’s
current etag value.

--performed-actions [complex type]

A list of actions that have been performed based on prior required
actions.

This option is a JSON list with items of type PerformedAction.  For
documentation on PerformedAction please see our API reference: https:
//docs.cloud.oracle.com/api/#/en/generativeaiagentruntime/20240531/da
tatypes/PerformedAction. This is a complex type whose value must be
valid JSON. The value can be provided as a string on the command line
or passed in as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--session-id [text]

Optional sessionId. If not provided, will chat without any prior
context.

--should-stream [boolean]

Whether to stream the response.

--tool-inputs [complex type]

Array of tool input objects, each specifying a tool’s ID, type, and
corresponding input parameters required for execution.

This option is a JSON list with items of type ToolInput.  For
documentation on ToolInput please see our API reference: https://docs
.cloud.oracle.com/api/#/en/generativeaiagentruntime/20240531/datatype
s/ToolInput. This is a complex type whose value must be valid JSON.
The value can be provided as a string on the command line or passed in
as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--tool-parameters [complex type]

A map where each key is a toolId and the value contains tool type and
additional dynamic parameters. This field is deprecated and will be
removed after July 02 2026. This is a complex type whose value must be
valid JSON. The value can be provided as a string on the command line
or passed in as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--user-message [text]

The input user message content for the chat.


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/agent-endpoint/chat.html#cmdoption-agent-endpoint-id

       oci generative-ai-agent-runtime agent-endpoint chat --agent-endpoint-id $agent_endpoint_id
