Namespace Oci.GenerativeaiagentruntimeService.Models
Classes
ChatDetails
Chat details for managing user interactions and tool executions.
ChatResult
The response of a chat request.
Citation
The source of information for the agent's response.
CreateSessionDetails
Information about the new session.
ErrorTrace
The trace information about the error.
ExecutionTrace
Contains trace information related to execution of tool.
FunctionCall
Represent a function call the client need to execute in order to fulfill the required action.
FunctionCallingPerformedAction
Represents an action for recording the result of a function call.
FunctionCallingRequiredAction
Represents an action for submitting function call outputs.
GenerationTrace
The trace information about the generated response.
GenericToolInput
Represents a generic tool input schema that accepts flexible, freeform JSON parameters. This structure is intended for tools that do not require a fixed input schema.
GenericToolOutput
Specifies an output format for tools that return freeform or unstructured JSON content.
HumanApprovalPerformedAction
An action describing user approval to the agent.
HumanApprovalRequiredAction
An object describing human confirmation of tool execution that is required from the user.
KnowledgeBaseMetadataSummary
Represents metadata about a field including its name, type, supported operations, and possible values.
KnowledgeBaseMetadataValue
Represents a metadata value and the number of appearances in knowledge base.
Message
The Message resource generated by the agent.
MessageContent
The content of the message.
MetadataFilter
Filter for retrieving specific metadata
ModelDetails
Model details.
ModelParams
Details of model parameters.
OciDatabaseSourceLocation
The location of the OCI Database that the agent will use.
OciObjectStorageSourceLocation
The OCI Object Storage that contains the data files.
OciOpenSearchSourceLocation
The location of the OCI Search with OpenSearch that the agent will use.
Paragraph
The paragraph of the generated message that contains a citation.
ParagraphCitation
The source of information for the paragraph of agent's response.
PerformedAction
The base structure for an action that has already been performed.
PerformedActionModelConverter
PlanningTrace
Contains trace information related to planning at the platform.
RagToolOutput
Specifies the output format for RAG tool, including the generated answer and citations.
RequiredAction
Represents an action that needs to be performed by the user or client.
RequiredActionModelConverter
RetrievalTrace
The trace that displays the retrieval information.
RetrieveMetadataDetails
Details to retrieve metadata
Session
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.
SourceDetails
The details of source of the event.
SourceLocation
The location of the data files that the agent will use.
SourceLocationModelConverter
SqlResultFiles
Specifies file locations for SQL result data.
SqlToolOutput
Specifies the output format for SQL tools, including the generated SQL statement and an optional preview of the query result.
ToolInput
Base object for tool input parameters. The 'toolInputType' discriminator determines the specific input structure to be used.
ToolInputModelConverter
ToolInvocationTrace
The trace information about the tool selection from multiple tools.
ToolOutput
Base schema for tool outputs. Identified by toolOutputType, which determines the format of the output content.
ToolOutputModelConverter
Trace
The trace that displays the internal progression, such as reasoning and actions during an execution.
TraceModelConverter
UpdateSessionDetails
Information about the updated session.
Usage
Details of usage.
UsageDetails
Usage details.