Show / Hide Table of Contents

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.

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.

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

ToolInvocationTrace

Pre-General Availability: 2024-01-24 |Important| |- |The following legal notice applies to Oracle pre-GA releases. For copyright and other applicable notices, see Oracle Legal Notices.
|Pre-General Availability Draft Documentation Notice| |- |This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation. This documentation is not a commitment by Oracle to deliver any material, code, functionality or services. This documentation, and Oracle Pre-GA programs and services are subject to change at any time without notice and, accordingly, should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality for Oracle's Pre-GA programs and services remains at the sole discretion of Oracle. All release dates or other predictions of future events are subject to change. The future availability of any future Oracle program or service should not be relied on in entering into any license or service agreement with Oracle. GenerationTrace

The trace information about the tool selection from multiple tools.

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.

Enums

HumanApprovalPerformedAction.ChosenOptionEnum

HumanApprovalRequiredAction.OptionsEnum

Message.RoleEnum

PerformedAction.PerformedActionTypeEnum

RequiredAction.RequiredActionTypeEnum

SourceLocation.SourceLocationTypeEnum

Trace.TraceTypeEnum

In this article
Back to top