Generative Ai Agent Runtime

oci.generative_ai_agent_runtime.GenerativeAiAgentRuntimeClient

OCI Generative AI Agents is a fully managed service that combines the power of large language models (LLMs) with an intelligent retrieval system to create contextually relevant answers by searching your knowledge base, making your AI applications smart and efficient.

oci.generative_ai_agent_runtime.GenerativeAiAgentRuntimeClientCompositeOperations

This class provides a wrapper around GenerativeAiAgentRuntimeClient and offers convenience methods for operations that would otherwise need to be chained together.

Models

oci.generative_ai_agent_runtime.models.ChatDetails

Chat details for managing user interactions and tool executions.

oci.generative_ai_agent_runtime.models.ChatResult

The response of a chat request.

oci.generative_ai_agent_runtime.models.Citation

The source of information for the agent's response.

oci.generative_ai_agent_runtime.models.CreateSessionDetails

Information about the new session.

oci.generative_ai_agent_runtime.models.ErrorTrace

The trace information about the error.

oci.generative_ai_agent_runtime.models.ExecutionTrace

Contains trace information related to execution of tool.

oci.generative_ai_agent_runtime.models.FunctionCall

Represent a function call the client need to execute in order to fulfill the required action.

oci.generative_ai_agent_runtime.models.FunctionCallingPerformedAction

Represents an action for recording the result of a function call.

oci.generative_ai_agent_runtime.models.FunctionCallingRequiredAction

Represents an action for submitting function call outputs.

oci.generative_ai_agent_runtime.models.GenerationTrace

The trace information about the generated response.

oci.generative_ai_agent_runtime.models.GenericToolInput

Represents a generic tool input schema that accepts flexible, freeform JSON parameters.

oci.generative_ai_agent_runtime.models.GenericToolOutput

Specifies an output format for tools that return freeform or unstructured JSON content.

oci.generative_ai_agent_runtime.models.HumanApprovalPerformedAction

An action describing user approval to the agent.

oci.generative_ai_agent_runtime.models.HumanApprovalRequiredAction

An object describing human confirmation of tool execution that is required from the user.

oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataSummary

Represents metadata about a field including its name, type, supported operations, and possible values.

oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataValue

Represents a metadata value and the number of appearances in knowledge base.

oci.generative_ai_agent_runtime.models.Message

The Message resource generated by the agent.

oci.generative_ai_agent_runtime.models.MessageContent

The content of the message.

oci.generative_ai_agent_runtime.models.MetadataFilter

Filter for retrieving specific metadata

oci.generative_ai_agent_runtime.models.ModelDetails

Model details.

oci.generative_ai_agent_runtime.models.ModelParams

Details of model parameters.

oci.generative_ai_agent_runtime.models.OciDatabaseSourceLocation

The location of the OCI Database that the agent will use.

oci.generative_ai_agent_runtime.models.OciObjectStorageSourceLocation

The OCI Object Storage that contains the data files.

oci.generative_ai_agent_runtime.models.OciOpenSearchSourceLocation

The location of the OCI Search with OpenSearch that the agent will use.

oci.generative_ai_agent_runtime.models.Paragraph

The paragraph of the generated message that contains a citation.

oci.generative_ai_agent_runtime.models.ParagraphCitation

The source of information for the paragraph of agent's response.

oci.generative_ai_agent_runtime.models.PerformedAction

The base structure for an action that has already been performed.

oci.generative_ai_agent_runtime.models.PlanningTrace

Contains trace information related to planning at the platform.

oci.generative_ai_agent_runtime.models.RagToolOutput

Specifies the output format for RAG tool, including the generated answer and citations.

oci.generative_ai_agent_runtime.models.RequiredAction

Represents an action that needs to be performed by the user or client.

oci.generative_ai_agent_runtime.models.RetrievalTrace

The trace that displays the retrieval information.

oci.generative_ai_agent_runtime.models.RetrieveMetadataDetails

Details to retrieve metadata

oci.generative_ai_agent_runtime.models.Session

A session represents an interactive conversation initiated by a user through an API to engage with an agent.

oci.generative_ai_agent_runtime.models.SourceDetails

The details of source of the event.

oci.generative_ai_agent_runtime.models.SourceLocation

The location of the data files that the agent will use.

oci.generative_ai_agent_runtime.models.SqlResultFiles

Specifies file locations for SQL result data.

oci.generative_ai_agent_runtime.models.SqlToolOutput

Specifies the output format for SQL tools, including the generated SQL statement and an optional preview of the query result.

oci.generative_ai_agent_runtime.models.ToolInput

Base object for tool input parameters.

oci.generative_ai_agent_runtime.models.ToolInvocationTrace

The trace information about the tool selection from multiple tools.

oci.generative_ai_agent_runtime.models.ToolOutput

Base schema for tool outputs.

oci.generative_ai_agent_runtime.models.Trace

The trace that displays the internal progression, such as reasoning and actions during an execution.

oci.generative_ai_agent_runtime.models.UpdateSessionDetails

Information about the updated session.

oci.generative_ai_agent_runtime.models.Usage

Details of usage.

oci.generative_ai_agent_runtime.models.UsageDetails

Usage details.