Documentation
¶
Index ¶
- func GetHumanApprovalPerformedActionChosenOptionEnumStringValues() []string
- func GetHumanApprovalRequiredActionOptionsEnumStringValues() []string
- func GetMessageRoleEnumStringValues() []string
- func GetPerformedActionPerformedActionTypeEnumStringValues() []string
- func GetRequiredActionRequiredActionTypeEnumStringValues() []string
- func GetSourceLocationSourceLocationTypeEnumStringValues() []string
- func GetToolInputToolInputTypeEnumStringValues() []string
- func GetToolOutputToolOutputTypeEnumStringValues() []string
- func GetTraceTraceTypeEnumStringValues() []string
- type ChatDetails
- type ChatRequest
- func (request ChatRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ChatRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ChatRequest) RetryPolicy() *common.RetryPolicy
- func (request ChatRequest) String() string
- func (request ChatRequest) ValidateEnumValue() (bool, error)
- type ChatResponse
- type ChatResult
- type Citation
- type CreateSessionDetails
- type CreateSessionRequest
- func (request CreateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request CreateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request CreateSessionRequest) RetryPolicy() *common.RetryPolicy
- func (request CreateSessionRequest) String() string
- func (request CreateSessionRequest) ValidateEnumValue() (bool, error)
- type CreateSessionResponse
- type DeleteSessionRequest
- func (request DeleteSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request DeleteSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request DeleteSessionRequest) RetryPolicy() *common.RetryPolicy
- func (request DeleteSessionRequest) String() string
- func (request DeleteSessionRequest) ValidateEnumValue() (bool, error)
- type DeleteSessionResponse
- type ErrorTrace
- func (m ErrorTrace) GetKey() *string
- func (m ErrorTrace) GetParentKey() *string
- func (m ErrorTrace) GetSource() *SourceDetails
- func (m ErrorTrace) GetTimeCreated() *common.SDKTime
- func (m ErrorTrace) GetTimeFinished() *common.SDKTime
- func (m ErrorTrace) MarshalJSON() (buff []byte, e error)
- func (m ErrorTrace) String() string
- func (m ErrorTrace) ValidateEnumValue() (bool, error)
- type ExecutionTrace
- func (m ExecutionTrace) GetKey() *string
- func (m ExecutionTrace) GetParentKey() *string
- func (m ExecutionTrace) GetSource() *SourceDetails
- func (m ExecutionTrace) GetTimeCreated() *common.SDKTime
- func (m ExecutionTrace) GetTimeFinished() *common.SDKTime
- func (m ExecutionTrace) MarshalJSON() (buff []byte, e error)
- func (m ExecutionTrace) String() string
- func (m ExecutionTrace) ValidateEnumValue() (bool, error)
- type FunctionCall
- type FunctionCallingPerformedAction
- type FunctionCallingRequiredAction
- type GenerationTrace
- func (m GenerationTrace) GetKey() *string
- func (m GenerationTrace) GetParentKey() *string
- func (m GenerationTrace) GetSource() *SourceDetails
- func (m GenerationTrace) GetTimeCreated() *common.SDKTime
- func (m GenerationTrace) GetTimeFinished() *common.SDKTime
- func (m GenerationTrace) MarshalJSON() (buff []byte, e error)
- func (m GenerationTrace) String() string
- func (m GenerationTrace) ValidateEnumValue() (bool, error)
- type GenerativeAiAgentRuntimeClient
- func NewGenerativeAiAgentRuntimeClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenerativeAiAgentRuntimeClient, err error)
- func NewGenerativeAiAgentRuntimeClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenerativeAiAgentRuntimeClient, err error)
- func (client GenerativeAiAgentRuntimeClient) Chat(ctx context.Context, request ChatRequest) (response ChatResponse, err error)
- func (client *GenerativeAiAgentRuntimeClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client GenerativeAiAgentRuntimeClient) CreateSession(ctx context.Context, request CreateSessionRequest) (response CreateSessionResponse, err error)
- func (client GenerativeAiAgentRuntimeClient) DeleteSession(ctx context.Context, request DeleteSessionRequest) (response DeleteSessionResponse, err error)
- func (client GenerativeAiAgentRuntimeClient) GetSession(ctx context.Context, request GetSessionRequest) (response GetSessionResponse, err error)
- func (client GenerativeAiAgentRuntimeClient) RetrieveMetadata(ctx context.Context, request RetrieveMetadataRequest) (response RetrieveMetadataResponse, err error)
- func (client *GenerativeAiAgentRuntimeClient) SetRegion(region string)
- func (client GenerativeAiAgentRuntimeClient) UpdateSession(ctx context.Context, request UpdateSessionRequest) (response UpdateSessionResponse, err error)
- type GenericToolInput
- type GenericToolOutput
- type GetSessionRequest
- func (request GetSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request GetSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request GetSessionRequest) RetryPolicy() *common.RetryPolicy
- func (request GetSessionRequest) String() string
- func (request GetSessionRequest) ValidateEnumValue() (bool, error)
- type GetSessionResponse
- type HumanApprovalPerformedAction
- type HumanApprovalPerformedActionChosenOptionEnum
- type HumanApprovalRequiredAction
- type HumanApprovalRequiredActionOptionsEnum
- type KnowledgeBaseMetadataSummary
- type KnowledgeBaseMetadataValue
- type Message
- type MessageContent
- type MessageRoleEnum
- type MetadataFilter
- type ModelDetails
- type ModelParams
- type OciDatabaseSourceLocation
- type OciObjectStorageSourceLocation
- type OciOpenSearchSourceLocation
- type Paragraph
- type ParagraphCitation
- type PerformedAction
- type PerformedActionPerformedActionTypeEnum
- type PlanningTrace
- func (m PlanningTrace) GetKey() *string
- func (m PlanningTrace) GetParentKey() *string
- func (m PlanningTrace) GetSource() *SourceDetails
- func (m PlanningTrace) GetTimeCreated() *common.SDKTime
- func (m PlanningTrace) GetTimeFinished() *common.SDKTime
- func (m PlanningTrace) MarshalJSON() (buff []byte, e error)
- func (m PlanningTrace) String() string
- func (m PlanningTrace) ValidateEnumValue() (bool, error)
- type RagToolOutput
- type RequiredAction
- type RequiredActionRequiredActionTypeEnum
- type RetrievalTrace
- func (m RetrievalTrace) GetKey() *string
- func (m RetrievalTrace) GetParentKey() *string
- func (m RetrievalTrace) GetSource() *SourceDetails
- func (m RetrievalTrace) GetTimeCreated() *common.SDKTime
- func (m RetrievalTrace) GetTimeFinished() *common.SDKTime
- func (m RetrievalTrace) MarshalJSON() (buff []byte, e error)
- func (m RetrievalTrace) String() string
- func (m RetrievalTrace) ValidateEnumValue() (bool, error)
- type RetrieveMetadataDetails
- type RetrieveMetadataRequest
- func (request RetrieveMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request RetrieveMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request RetrieveMetadataRequest) RetryPolicy() *common.RetryPolicy
- func (request RetrieveMetadataRequest) String() string
- func (request RetrieveMetadataRequest) ValidateEnumValue() (bool, error)
- type RetrieveMetadataResponse
- type Session
- type SourceDetails
- type SourceLocation
- type SourceLocationSourceLocationTypeEnum
- type SqlResultFiles
- type SqlToolOutput
- type ToolInput
- type ToolInputToolInputTypeEnum
- type ToolInvocationTrace
- func (m ToolInvocationTrace) GetKey() *string
- func (m ToolInvocationTrace) GetParentKey() *string
- func (m ToolInvocationTrace) GetSource() *SourceDetails
- func (m ToolInvocationTrace) GetTimeCreated() *common.SDKTime
- func (m ToolInvocationTrace) GetTimeFinished() *common.SDKTime
- func (m ToolInvocationTrace) MarshalJSON() (buff []byte, e error)
- func (m ToolInvocationTrace) String() string
- func (m ToolInvocationTrace) ValidateEnumValue() (bool, error)
- type ToolOutput
- type ToolOutputToolOutputTypeEnum
- type Trace
- type TraceTraceTypeEnum
- type UpdateSessionDetails
- type UpdateSessionRequest
- func (request UpdateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request UpdateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request UpdateSessionRequest) RetryPolicy() *common.RetryPolicy
- func (request UpdateSessionRequest) String() string
- func (request UpdateSessionRequest) ValidateEnumValue() (bool, error)
- type UpdateSessionResponse
- type Usage
- type UsageDetails
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetHumanApprovalPerformedActionChosenOptionEnumStringValues ¶ added in v65.88.0
func GetHumanApprovalPerformedActionChosenOptionEnumStringValues() []string
GetHumanApprovalPerformedActionChosenOptionEnumStringValues Enumerates the set of values in String for HumanApprovalPerformedActionChosenOptionEnum
func GetHumanApprovalRequiredActionOptionsEnumStringValues ¶ added in v65.93.0
func GetHumanApprovalRequiredActionOptionsEnumStringValues() []string
GetHumanApprovalRequiredActionOptionsEnumStringValues Enumerates the set of values in String for HumanApprovalRequiredActionOptionsEnum
func GetMessageRoleEnumStringValues ¶
func GetMessageRoleEnumStringValues() []string
GetMessageRoleEnumStringValues Enumerates the set of values in String for MessageRoleEnum
func GetPerformedActionPerformedActionTypeEnumStringValues ¶ added in v65.88.0
func GetPerformedActionPerformedActionTypeEnumStringValues() []string
GetPerformedActionPerformedActionTypeEnumStringValues Enumerates the set of values in String for PerformedActionPerformedActionTypeEnum
func GetRequiredActionRequiredActionTypeEnumStringValues ¶ added in v65.88.0
func GetRequiredActionRequiredActionTypeEnumStringValues() []string
GetRequiredActionRequiredActionTypeEnumStringValues Enumerates the set of values in String for RequiredActionRequiredActionTypeEnum
func GetSourceLocationSourceLocationTypeEnumStringValues ¶
func GetSourceLocationSourceLocationTypeEnumStringValues() []string
GetSourceLocationSourceLocationTypeEnumStringValues Enumerates the set of values in String for SourceLocationSourceLocationTypeEnum
func GetToolInputToolInputTypeEnumStringValues ¶ added in v65.96.0
func GetToolInputToolInputTypeEnumStringValues() []string
GetToolInputToolInputTypeEnumStringValues Enumerates the set of values in String for ToolInputToolInputTypeEnum
func GetToolOutputToolOutputTypeEnumStringValues ¶ added in v65.96.0
func GetToolOutputToolOutputTypeEnumStringValues() []string
GetToolOutputToolOutputTypeEnumStringValues Enumerates the set of values in String for ToolOutputToolOutputTypeEnum
func GetTraceTraceTypeEnumStringValues ¶
func GetTraceTraceTypeEnumStringValues() []string
GetTraceTraceTypeEnumStringValues Enumerates the set of values in String for TraceTraceTypeEnum
Types ¶
type ChatDetails ¶
type ChatDetails struct { // The input user message content for the chat. UserMessage *string `mandatory:"false" json:"userMessage"` // Whether to stream the response. ShouldStream *bool `mandatory:"false" json:"shouldStream"` // Optional sessionId. If not provided, will chat without any prior context. SessionId *string `mandatory:"false" json:"sessionId"` // 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. ToolParameters map[string]string `mandatory:"false" json:"toolParameters"` // Array of tool input objects, each specifying a tool's ID, type, and corresponding input parameters required for execution. ToolInputs []ToolInput `mandatory:"false" json:"toolInputs"` // A list of actions that have been performed based on prior required actions. PerformedActions []PerformedAction `mandatory:"false" json:"performedActions"` }
ChatDetails Chat details for managing user interactions and tool executions.
func (ChatDetails) String ¶
func (m ChatDetails) String() string
func (*ChatDetails) UnmarshalJSON ¶ added in v65.88.0
func (m *ChatDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (ChatDetails) ValidateEnumValue ¶
func (m ChatDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ChatRequest ¶
type ChatRequest struct { // A unique ID for the endpoint. AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"` // Input for chat. ChatDetails `contributesTo:"body"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // 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. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations. For example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
ChatRequest wrapper for the Chat operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/Chat.go.html to see an example of how to use ChatRequest.
func (ChatRequest) BinaryRequestBody ¶
func (request ChatRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ChatRequest) HTTPRequest ¶
func (request ChatRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ChatRequest) RetryPolicy ¶
func (request ChatRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ChatRequest) String ¶
func (request ChatRequest) String() string
func (ChatRequest) ValidateEnumValue ¶
func (request ChatRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ChatResponse ¶
type ChatResponse struct { // The underlying http response RawResponse *http.Response // The ChatResult instance ChatResult `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
ChatResponse wrapper for the Chat operation
func (ChatResponse) HTTPResponse ¶
func (response ChatResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ChatResponse) String ¶
func (response ChatResponse) String() string
type ChatResult ¶
type ChatResult struct { Message *Message `mandatory:"false" json:"message"` // The trace that displays the internal progression, such as reasoning and actions during an execution. Traces []Trace `mandatory:"false" json:"traces"` // A map where each key is a toolId and the value contains tool type and additional dynamic results. This field is deprecated and will be removed after July 02 2026. ToolResults map[string]string `mandatory:"false" json:"toolResults"` // Array of tool outputs in execution order. Each item includes the tool OCID, output type, // and corresponding content. The result structure is defined by the `toolOutputType` discriminator. ToolOutputs []ToolOutput `mandatory:"false" json:"toolOutputs"` // A list of actions the agent requires the user or agent client to perform. RequiredActions []RequiredAction `mandatory:"false" json:"requiredActions"` // Captures the result of guardrail evaluations as JSON string performed on either the input to the agent or the output generated by the agent. GuardrailResult *string `mandatory:"false" json:"guardrailResult"` }
ChatResult The response of a chat request.
func (ChatResult) String ¶
func (m ChatResult) String() string
func (*ChatResult) UnmarshalJSON ¶
func (m *ChatResult) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (ChatResult) ValidateEnumValue ¶
func (m ChatResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type Citation ¶
type Citation struct { // The text that's the source for the agent's response. SourceText *string `mandatory:"false" json:"sourceText"` SourceLocation SourceLocation `mandatory:"false" json:"sourceLocation"` // The title of the source text, if available. Title *string `mandatory:"false" json:"title"` // The id of the retrieved document, if available. DocId *string `mandatory:"false" json:"docId"` // The page numbers on the retrieved document, if available. PageNumbers []int `mandatory:"false" json:"pageNumbers"` // The metadata of the retrieved document, if available. Metadata map[string]interface{} `mandatory:"false" json:"metadata"` }
Citation The source of information for the agent's response.
func (*Citation) UnmarshalJSON ¶
UnmarshalJSON unmarshals from json
func (Citation) ValidateEnumValue ¶
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type CreateSessionDetails ¶
type CreateSessionDetails struct { // The name of the session. A session names doesn't have to be unique and you can change the session name later. DisplayName *string `mandatory:"false" json:"displayName"` // An optional description of the session. Description *string `mandatory:"false" json:"description"` }
CreateSessionDetails Information about the new session.
func (CreateSessionDetails) String ¶
func (m CreateSessionDetails) String() string
func (CreateSessionDetails) ValidateEnumValue ¶
func (m CreateSessionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type CreateSessionRequest ¶
type CreateSessionRequest struct { // Details for the new agent session. CreateSessionDetails `contributesTo:"body"` // A unique ID for the endpoint. AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations. For example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
CreateSessionRequest wrapper for the CreateSession operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/CreateSession.go.html to see an example of how to use CreateSessionRequest.
func (CreateSessionRequest) BinaryRequestBody ¶
func (request CreateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (CreateSessionRequest) HTTPRequest ¶
func (request CreateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateSessionRequest) RetryPolicy ¶
func (request CreateSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateSessionRequest) String ¶
func (request CreateSessionRequest) String() string
func (CreateSessionRequest) ValidateEnumValue ¶
func (request CreateSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type CreateSessionResponse ¶
type CreateSessionResponse struct { // The underlying http response RawResponse *http.Response // The Session instance Session `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
CreateSessionResponse wrapper for the CreateSession operation
func (CreateSessionResponse) HTTPResponse ¶
func (response CreateSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateSessionResponse) String ¶
func (response CreateSessionResponse) String() string
type DeleteSessionRequest ¶
type DeleteSessionRequest struct { // A unique ID for the endpoint. AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"` // A unique ID for the session. SessionId *string `mandatory:"true" contributesTo:"path" name:"sessionId"` // 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. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
DeleteSessionRequest wrapper for the DeleteSession operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/DeleteSession.go.html to see an example of how to use DeleteSessionRequest.
func (DeleteSessionRequest) BinaryRequestBody ¶
func (request DeleteSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (DeleteSessionRequest) HTTPRequest ¶
func (request DeleteSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteSessionRequest) RetryPolicy ¶
func (request DeleteSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteSessionRequest) String ¶
func (request DeleteSessionRequest) String() string
func (DeleteSessionRequest) ValidateEnumValue ¶
func (request DeleteSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type DeleteSessionResponse ¶
type DeleteSessionResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
DeleteSessionResponse wrapper for the DeleteSession operation
func (DeleteSessionResponse) HTTPResponse ¶
func (response DeleteSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteSessionResponse) String ¶
func (response DeleteSessionResponse) String() string
type ErrorTrace ¶
type ErrorTrace struct { // Unique identifier for the event (UUID). Key *string `mandatory:"false" json:"key"` // Identifier of the parent event, if applicable (UUID). ParentKey *string `mandatory:"false" json:"parentKey"` Source *SourceDetails `mandatory:"false" json:"source"` // The date and time that the trace was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Timestamp for when the event ended (In RFC 3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` // The error message in this trace. ErrorMessage *string `mandatory:"false" json:"errorMessage"` // Error code. Code *string `mandatory:"false" json:"code"` }
ErrorTrace The trace information about the error.
func (ErrorTrace) GetKey ¶ added in v65.93.0
func (m ErrorTrace) GetKey() *string
GetKey returns Key
func (ErrorTrace) GetParentKey ¶ added in v65.93.0
func (m ErrorTrace) GetParentKey() *string
GetParentKey returns ParentKey
func (ErrorTrace) GetSource ¶ added in v65.93.0
func (m ErrorTrace) GetSource() *SourceDetails
GetSource returns Source
func (ErrorTrace) GetTimeCreated ¶
func (m ErrorTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (ErrorTrace) GetTimeFinished ¶ added in v65.93.0
func (m ErrorTrace) GetTimeFinished() *common.SDKTime
GetTimeFinished returns TimeFinished
func (ErrorTrace) MarshalJSON ¶
func (m ErrorTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (ErrorTrace) String ¶
func (m ErrorTrace) String() string
func (ErrorTrace) ValidateEnumValue ¶
func (m ErrorTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ExecutionTrace ¶ added in v65.93.0
type ExecutionTrace struct { // Unique identifier for the event (UUID). Key *string `mandatory:"false" json:"key"` // Identifier of the parent event, if applicable (UUID). ParentKey *string `mandatory:"false" json:"parentKey"` Source *SourceDetails `mandatory:"false" json:"source"` // The date and time that the trace was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Timestamp for when the event ended (In RFC 3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` // Input data. Input *string `mandatory:"false" json:"input"` // Output data. Output *string `mandatory:"false" json:"output"` }
ExecutionTrace Contains trace information related to execution of tool.
func (ExecutionTrace) GetKey ¶ added in v65.93.0
func (m ExecutionTrace) GetKey() *string
GetKey returns Key
func (ExecutionTrace) GetParentKey ¶ added in v65.93.0
func (m ExecutionTrace) GetParentKey() *string
GetParentKey returns ParentKey
func (ExecutionTrace) GetSource ¶ added in v65.93.0
func (m ExecutionTrace) GetSource() *SourceDetails
GetSource returns Source
func (ExecutionTrace) GetTimeCreated ¶ added in v65.93.0
func (m ExecutionTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (ExecutionTrace) GetTimeFinished ¶ added in v65.93.0
func (m ExecutionTrace) GetTimeFinished() *common.SDKTime
GetTimeFinished returns TimeFinished
func (ExecutionTrace) MarshalJSON ¶ added in v65.93.0
func (m ExecutionTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (ExecutionTrace) String ¶ added in v65.93.0
func (m ExecutionTrace) String() string
func (ExecutionTrace) ValidateEnumValue ¶ added in v65.93.0
func (m ExecutionTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type FunctionCall ¶ added in v65.88.0
type FunctionCall struct { // Name of the function to be executed. Name *string `mandatory:"true" json:"name"` // Arguments for the function call as a JSON string. Arguments *string `mandatory:"true" json:"arguments"` }
FunctionCall Represent a function call the client need to execute in order to fulfill the required action.
func (FunctionCall) String ¶ added in v65.88.0
func (m FunctionCall) String() string
func (FunctionCall) ValidateEnumValue ¶ added in v65.88.0
func (m FunctionCall) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type FunctionCallingPerformedAction ¶ added in v65.88.0
type FunctionCallingPerformedAction struct { // The unique identifier for the action that has been performed. ActionId *string `mandatory:"true" json:"actionId"` // The result or output of the function call. FunctionCallOutput *string `mandatory:"true" json:"functionCallOutput"` }
FunctionCallingPerformedAction Represents an action for recording the result of a function call.
func (FunctionCallingPerformedAction) GetActionId ¶ added in v65.88.0
func (m FunctionCallingPerformedAction) GetActionId() *string
GetActionId returns ActionId
func (FunctionCallingPerformedAction) MarshalJSON ¶ added in v65.88.0
func (m FunctionCallingPerformedAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (FunctionCallingPerformedAction) String ¶ added in v65.88.0
func (m FunctionCallingPerformedAction) String() string
func (FunctionCallingPerformedAction) ValidateEnumValue ¶ added in v65.88.0
func (m FunctionCallingPerformedAction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type FunctionCallingRequiredAction ¶ added in v65.88.0
type FunctionCallingRequiredAction struct { // The unique identifier for the action to be performed. ActionId *string `mandatory:"true" json:"actionId"` FunctionCall *FunctionCall `mandatory:"true" json:"functionCall"` }
FunctionCallingRequiredAction Represents an action for submitting function call outputs.
func (FunctionCallingRequiredAction) GetActionId ¶ added in v65.88.0
func (m FunctionCallingRequiredAction) GetActionId() *string
GetActionId returns ActionId
func (FunctionCallingRequiredAction) MarshalJSON ¶ added in v65.88.0
func (m FunctionCallingRequiredAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (FunctionCallingRequiredAction) String ¶ added in v65.88.0
func (m FunctionCallingRequiredAction) String() string
func (FunctionCallingRequiredAction) ValidateEnumValue ¶ added in v65.88.0
func (m FunctionCallingRequiredAction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type GenerationTrace ¶
type GenerationTrace struct { // Unique identifier for the event (UUID). Key *string `mandatory:"false" json:"key"` // Identifier of the parent event, if applicable (UUID). ParentKey *string `mandatory:"false" json:"parentKey"` Source *SourceDetails `mandatory:"false" json:"source"` // The date and time that the trace was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Timestamp for when the event ended (In RFC 3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` // The generated response that's returned to the user. Generation *string `mandatory:"false" json:"generation"` // The input to the generation operation. Input *string `mandatory:"false" json:"input"` // Details of model and its usage. Usage []Usage `mandatory:"false" json:"usage"` }
GenerationTrace The trace information about the generated response.
func (GenerationTrace) GetKey ¶ added in v65.93.0
func (m GenerationTrace) GetKey() *string
GetKey returns Key
func (GenerationTrace) GetParentKey ¶ added in v65.93.0
func (m GenerationTrace) GetParentKey() *string
GetParentKey returns ParentKey
func (GenerationTrace) GetSource ¶ added in v65.93.0
func (m GenerationTrace) GetSource() *SourceDetails
GetSource returns Source
func (GenerationTrace) GetTimeCreated ¶
func (m GenerationTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (GenerationTrace) GetTimeFinished ¶ added in v65.93.0
func (m GenerationTrace) GetTimeFinished() *common.SDKTime
GetTimeFinished returns TimeFinished
func (GenerationTrace) MarshalJSON ¶
func (m GenerationTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (GenerationTrace) String ¶
func (m GenerationTrace) String() string
func (GenerationTrace) ValidateEnumValue ¶
func (m GenerationTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type GenerativeAiAgentRuntimeClient ¶
type GenerativeAiAgentRuntimeClient struct { common.BaseClient // contains filtered or unexported fields }
GenerativeAiAgentRuntimeClient a client for GenerativeAiAgentRuntime
func NewGenerativeAiAgentRuntimeClientWithConfigurationProvider ¶
func NewGenerativeAiAgentRuntimeClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenerativeAiAgentRuntimeClient, err error)
NewGenerativeAiAgentRuntimeClientWithConfigurationProvider Creates a new default GenerativeAiAgentRuntime client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGenerativeAiAgentRuntimeClientWithOboToken ¶
func NewGenerativeAiAgentRuntimeClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenerativeAiAgentRuntimeClient, err error)
NewGenerativeAiAgentRuntimeClientWithOboToken Creates a new default GenerativeAiAgentRuntime client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (GenerativeAiAgentRuntimeClient) Chat ¶
func (client GenerativeAiAgentRuntimeClient) Chat(ctx context.Context, request ChatRequest) (response ChatResponse, err error)
Chat Chat on endpoint with provided messages.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/Chat.go.html to see an example of how to use Chat API. A default retry strategy applies to this operation Chat()
func (*GenerativeAiAgentRuntimeClient) ConfigurationProvider ¶
func (client *GenerativeAiAgentRuntimeClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (GenerativeAiAgentRuntimeClient) CreateSession ¶
func (client GenerativeAiAgentRuntimeClient) CreateSession(ctx context.Context, request CreateSessionRequest) (response CreateSessionResponse, err error)
CreateSession 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.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/CreateSession.go.html to see an example of how to use CreateSession API. A default retry strategy applies to this operation CreateSession()
func (GenerativeAiAgentRuntimeClient) DeleteSession ¶
func (client GenerativeAiAgentRuntimeClient) DeleteSession(ctx context.Context, request DeleteSessionRequest) (response DeleteSessionResponse, err error)
DeleteSession Delete a session and all its associated information.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/DeleteSession.go.html to see an example of how to use DeleteSession API. A default retry strategy applies to this operation DeleteSession()
func (GenerativeAiAgentRuntimeClient) GetSession ¶
func (client GenerativeAiAgentRuntimeClient) GetSession(ctx context.Context, request GetSessionRequest) (response GetSessionResponse, err error)
GetSession Return the session resource identified by the session ID.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/GetSession.go.html to see an example of how to use GetSession API. A default retry strategy applies to this operation GetSession()
func (GenerativeAiAgentRuntimeClient) RetrieveMetadata ¶ added in v65.88.0
func (client GenerativeAiAgentRuntimeClient) RetrieveMetadata(ctx context.Context, request RetrieveMetadataRequest) (response RetrieveMetadataResponse, err error)
RetrieveMetadata Returns metadata of provided knowledgeBase. Return available metadata with information of field names, their types, supported operations, and possible values.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/RetrieveMetadata.go.html to see an example of how to use RetrieveMetadata API. A default retry strategy applies to this operation RetrieveMetadata()
func (*GenerativeAiAgentRuntimeClient) SetRegion ¶
func (client *GenerativeAiAgentRuntimeClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (GenerativeAiAgentRuntimeClient) UpdateSession ¶
func (client GenerativeAiAgentRuntimeClient) UpdateSession(ctx context.Context, request UpdateSessionRequest) (response UpdateSessionResponse, err error)
UpdateSession Update session metadata, including but not limited to description, tags.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/UpdateSession.go.html to see an example of how to use UpdateSession API. A default retry strategy applies to this operation UpdateSession()
type GenericToolInput ¶ added in v65.96.0
type GenericToolInput struct { // Unique OCID of the tool. ToolId *string `mandatory:"true" json:"toolId"` // A freeform JSON object containing the input parameters to be passed to the tool during execution. Input *interface{} `mandatory:"true" json:"input"` }
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.
func (GenericToolInput) GetToolId ¶ added in v65.96.0
func (m GenericToolInput) GetToolId() *string
GetToolId returns ToolId
func (GenericToolInput) MarshalJSON ¶ added in v65.96.0
func (m GenericToolInput) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (GenericToolInput) String ¶ added in v65.96.0
func (m GenericToolInput) String() string
func (GenericToolInput) ValidateEnumValue ¶ added in v65.96.0
func (m GenericToolInput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type GenericToolOutput ¶ added in v65.96.0
type GenericToolOutput struct { // Specifies the unique OCID of the tool. ToolId *string `mandatory:"true" json:"toolId"` // Specifies the freeform JSON object containing the tool’s output. Output *interface{} `mandatory:"true" json:"output"` // Specifies the display name of the tool. ToolName *string `mandatory:"false" json:"toolName"` }
GenericToolOutput Specifies an output format for tools that return freeform or unstructured JSON content.
func (GenericToolOutput) GetToolId ¶ added in v65.96.0
func (m GenericToolOutput) GetToolId() *string
GetToolId returns ToolId
func (GenericToolOutput) GetToolName ¶ added in v65.96.0
func (m GenericToolOutput) GetToolName() *string
GetToolName returns ToolName
func (GenericToolOutput) MarshalJSON ¶ added in v65.96.0
func (m GenericToolOutput) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (GenericToolOutput) String ¶ added in v65.96.0
func (m GenericToolOutput) String() string
func (GenericToolOutput) ValidateEnumValue ¶ added in v65.96.0
func (m GenericToolOutput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type GetSessionRequest ¶
type GetSessionRequest struct { // A unique ID for the endpoint. AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"` // A unique ID for the session. SessionId *string `mandatory:"true" contributesTo:"path" name:"sessionId"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
GetSessionRequest wrapper for the GetSession operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/GetSession.go.html to see an example of how to use GetSessionRequest.
func (GetSessionRequest) BinaryRequestBody ¶
func (request GetSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (GetSessionRequest) HTTPRequest ¶
func (request GetSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetSessionRequest) RetryPolicy ¶
func (request GetSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetSessionRequest) String ¶
func (request GetSessionRequest) String() string
func (GetSessionRequest) ValidateEnumValue ¶
func (request GetSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type GetSessionResponse ¶
type GetSessionResponse struct { // The underlying http response RawResponse *http.Response // The Session instance Session `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
GetSessionResponse wrapper for the GetSession operation
func (GetSessionResponse) HTTPResponse ¶
func (response GetSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetSessionResponse) String ¶
func (response GetSessionResponse) String() string
type HumanApprovalPerformedAction ¶ added in v65.88.0
type HumanApprovalPerformedAction struct { // The unique identifier for the action that has been performed. ActionId *string `mandatory:"true" json:"actionId"` // The chosen approval or denial option to the agent. ChosenOption HumanApprovalPerformedActionChosenOptionEnum `mandatory:"true" json:"chosenOption"` }
HumanApprovalPerformedAction An action describing user approval to the agent.
func (HumanApprovalPerformedAction) GetActionId ¶ added in v65.88.0
func (m HumanApprovalPerformedAction) GetActionId() *string
GetActionId returns ActionId
func (HumanApprovalPerformedAction) MarshalJSON ¶ added in v65.88.0
func (m HumanApprovalPerformedAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (HumanApprovalPerformedAction) String ¶ added in v65.88.0
func (m HumanApprovalPerformedAction) String() string
func (HumanApprovalPerformedAction) ValidateEnumValue ¶ added in v65.88.0
func (m HumanApprovalPerformedAction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type HumanApprovalPerformedActionChosenOptionEnum ¶ added in v65.88.0
type HumanApprovalPerformedActionChosenOptionEnum string
HumanApprovalPerformedActionChosenOptionEnum Enum with underlying type: string
const ( HumanApprovalPerformedActionChosenOptionApprove HumanApprovalPerformedActionChosenOptionEnum = "APPROVE" HumanApprovalPerformedActionChosenOptionDeny HumanApprovalPerformedActionChosenOptionEnum = "DENY" )
Set of constants representing the allowable values for HumanApprovalPerformedActionChosenOptionEnum
func GetHumanApprovalPerformedActionChosenOptionEnumValues ¶ added in v65.88.0
func GetHumanApprovalPerformedActionChosenOptionEnumValues() []HumanApprovalPerformedActionChosenOptionEnum
GetHumanApprovalPerformedActionChosenOptionEnumValues Enumerates the set of values for HumanApprovalPerformedActionChosenOptionEnum
func GetMappingHumanApprovalPerformedActionChosenOptionEnum ¶ added in v65.88.0
func GetMappingHumanApprovalPerformedActionChosenOptionEnum(val string) (HumanApprovalPerformedActionChosenOptionEnum, bool)
GetMappingHumanApprovalPerformedActionChosenOptionEnum performs case Insensitive comparison on enum value and return the desired enum
type HumanApprovalRequiredAction ¶ added in v65.93.0
type HumanApprovalRequiredAction struct { // The unique identifier for the action to be performed. ActionId *string `mandatory:"true" json:"actionId"` // Message accompanying the human input request asking for approval or denial of a tool execution. Message *string `mandatory:"true" json:"message"` // The options presented to the user approving and denying execution of the tool. Options []HumanApprovalRequiredActionOptionsEnum `mandatory:"true" json:"options"` }
HumanApprovalRequiredAction An object describing human confirmation of tool execution that is required from the user.
func (HumanApprovalRequiredAction) GetActionId ¶ added in v65.93.0
func (m HumanApprovalRequiredAction) GetActionId() *string
GetActionId returns ActionId
func (HumanApprovalRequiredAction) MarshalJSON ¶ added in v65.93.0
func (m HumanApprovalRequiredAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (HumanApprovalRequiredAction) String ¶ added in v65.93.0
func (m HumanApprovalRequiredAction) String() string
func (HumanApprovalRequiredAction) ValidateEnumValue ¶ added in v65.93.0
func (m HumanApprovalRequiredAction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type HumanApprovalRequiredActionOptionsEnum ¶ added in v65.93.0
type HumanApprovalRequiredActionOptionsEnum string
HumanApprovalRequiredActionOptionsEnum Enum with underlying type: string
const ( HumanApprovalRequiredActionOptionsApprove HumanApprovalRequiredActionOptionsEnum = "APPROVE" HumanApprovalRequiredActionOptionsDeny HumanApprovalRequiredActionOptionsEnum = "DENY" )
Set of constants representing the allowable values for HumanApprovalRequiredActionOptionsEnum
func GetHumanApprovalRequiredActionOptionsEnumValues ¶ added in v65.93.0
func GetHumanApprovalRequiredActionOptionsEnumValues() []HumanApprovalRequiredActionOptionsEnum
GetHumanApprovalRequiredActionOptionsEnumValues Enumerates the set of values for HumanApprovalRequiredActionOptionsEnum
func GetMappingHumanApprovalRequiredActionOptionsEnum ¶ added in v65.93.0
func GetMappingHumanApprovalRequiredActionOptionsEnum(val string) (HumanApprovalRequiredActionOptionsEnum, bool)
GetMappingHumanApprovalRequiredActionOptionsEnum performs case Insensitive comparison on enum value and return the desired enum
type KnowledgeBaseMetadataSummary ¶ added in v65.88.0
type KnowledgeBaseMetadataSummary struct { // The name of the field Name *string `mandatory:"true" json:"name"` // The data type of the field (e.g., "array", "number", "string") Type *string `mandatory:"true" json:"type"` // List of supported operations for this field (e.g., "equals", "in", "contains") Operations []string `mandatory:"true" json:"operations"` // List of metadata values available in the knowledge base along with the matching documents count. Values []KnowledgeBaseMetadataValue `mandatory:"true" json:"values"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // System tags for this resource. Each key is predefined and scoped to a namespace. // Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"` }
KnowledgeBaseMetadataSummary Represents metadata about a field including its name, type, supported operations, and possible values.
func (KnowledgeBaseMetadataSummary) String ¶ added in v65.88.0
func (m KnowledgeBaseMetadataSummary) String() string
func (KnowledgeBaseMetadataSummary) ValidateEnumValue ¶ added in v65.88.0
func (m KnowledgeBaseMetadataSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type KnowledgeBaseMetadataValue ¶ added in v65.88.0
type KnowledgeBaseMetadataValue struct { // The value of the metadata Value *string `mandatory:"true" json:"value"` // Number of documents where this value exists Count *int64 `mandatory:"true" json:"count"` }
KnowledgeBaseMetadataValue Represents a metadata value and the number of appearances in knowledge base.
func (KnowledgeBaseMetadataValue) String ¶ added in v65.88.0
func (m KnowledgeBaseMetadataValue) String() string
func (KnowledgeBaseMetadataValue) ValidateEnumValue ¶ added in v65.88.0
func (m KnowledgeBaseMetadataValue) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type Message ¶
type Message struct { // The role of the sender of this message. Role MessageRoleEnum `mandatory:"true" json:"role"` Content *MessageContent `mandatory:"true" json:"content"` // The date and time that the message was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` }
Message The Message resource generated by the agent.
func (Message) ValidateEnumValue ¶
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type MessageContent ¶
type MessageContent struct { // The content of the message. Text *string `mandatory:"true" json:"text"` // Citations to data sources used for generating an agent's message. Citations []Citation `mandatory:"false" json:"citations"` // A list of citations used to generate the paragraphs of the agent message. ParagraphCitations []ParagraphCitation `mandatory:"false" json:"paragraphCitations"` }
MessageContent The content of the message.
func (MessageContent) String ¶
func (m MessageContent) String() string
func (MessageContent) ValidateEnumValue ¶
func (m MessageContent) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type MessageRoleEnum ¶
type MessageRoleEnum string
MessageRoleEnum Enum with underlying type: string
const ( MessageRoleUser MessageRoleEnum = "USER" MessageRoleAgent MessageRoleEnum = "AGENT" )
Set of constants representing the allowable values for MessageRoleEnum
func GetMappingMessageRoleEnum ¶
func GetMappingMessageRoleEnum(val string) (MessageRoleEnum, bool)
GetMappingMessageRoleEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMessageRoleEnumValues ¶
func GetMessageRoleEnumValues() []MessageRoleEnum
GetMessageRoleEnumValues Enumerates the set of values for MessageRoleEnum
type MetadataFilter ¶ added in v65.88.0
type MetadataFilter struct { // The name of the field to filter on FieldName *string `mandatory:"true" json:"fieldName"` // The value to filter for in the specified field Value *string `mandatory:"true" json:"value"` }
MetadataFilter Filter for retrieving specific metadata
func (MetadataFilter) String ¶ added in v65.88.0
func (m MetadataFilter) String() string
func (MetadataFilter) ValidateEnumValue ¶ added in v65.88.0
func (m MetadataFilter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ModelDetails ¶ added in v65.93.0
type ModelDetails struct { // Name of the model. ModelName *string `mandatory:"false" json:"modelName"` // Version of the model. ModelVersion *string `mandatory:"false" json:"modelVersion"` ModelParams *ModelParams `mandatory:"false" json:"modelParams"` }
ModelDetails Model details.
func (ModelDetails) String ¶ added in v65.93.0
func (m ModelDetails) String() string
func (ModelDetails) ValidateEnumValue ¶ added in v65.93.0
func (m ModelDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ModelParams ¶ added in v65.93.0
type ModelParams struct { // Maximum number of tokens. MaxTokens *int `mandatory:"false" json:"maxTokens"` // Sampling temperature. Temperature *float32 `mandatory:"false" json:"temperature"` // Nucleus sampling probability. TopP *float32 `mandatory:"false" json:"topP"` // Top-K sampling parameter. TopK *int `mandatory:"false" json:"topK"` // Frequency penalty to reduce repeating tokens. FrequencyPenalty *float32 `mandatory:"false" json:"frequencyPenalty"` // Presence penalty to encourage new topics. PresencePenalty *float32 `mandatory:"false" json:"presencePenalty"` }
ModelParams Details of model parameters.
func (ModelParams) String ¶ added in v65.93.0
func (m ModelParams) String() string
func (ModelParams) ValidateEnumValue ¶ added in v65.93.0
func (m ModelParams) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type OciDatabaseSourceLocation ¶
type OciDatabaseSourceLocation struct { // The OCID of the OCI Database Tools Connection (https://docs.oracle.com/iaas/database-tools/home.htm). Id *string `mandatory:"false" json:"id"` // The name of the function that returns source text. FunctionName *string `mandatory:"false" json:"functionName"` // The URL of the retrieved document, if available. Url *string `mandatory:"false" json:"url"` }
OciDatabaseSourceLocation The location of the OCI Database that the agent will use.
func (OciDatabaseSourceLocation) MarshalJSON ¶
func (m OciDatabaseSourceLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (OciDatabaseSourceLocation) String ¶
func (m OciDatabaseSourceLocation) String() string
func (OciDatabaseSourceLocation) ValidateEnumValue ¶
func (m OciDatabaseSourceLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type OciObjectStorageSourceLocation ¶
type OciObjectStorageSourceLocation struct { // The URL of the OCI Object Storage data source. Url *string `mandatory:"false" json:"url"` }
OciObjectStorageSourceLocation The OCI Object Storage that contains the data files.
func (OciObjectStorageSourceLocation) MarshalJSON ¶
func (m OciObjectStorageSourceLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (OciObjectStorageSourceLocation) String ¶
func (m OciObjectStorageSourceLocation) String() string
func (OciObjectStorageSourceLocation) ValidateEnumValue ¶
func (m OciObjectStorageSourceLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type OciOpenSearchSourceLocation ¶
type OciOpenSearchSourceLocation struct { // The OCID of the OCI OpenSearch cluster. Id *string `mandatory:"false" json:"id"` // The name of the index in OpenSearch that contains the source text. IndexName *string `mandatory:"false" json:"indexName"` // The URL of the retrieved document, if available. Url *string `mandatory:"false" json:"url"` }
OciOpenSearchSourceLocation The location of the OCI Search with OpenSearch that the agent will use.
func (OciOpenSearchSourceLocation) MarshalJSON ¶
func (m OciOpenSearchSourceLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (OciOpenSearchSourceLocation) String ¶
func (m OciOpenSearchSourceLocation) String() string
func (OciOpenSearchSourceLocation) ValidateEnumValue ¶
func (m OciOpenSearchSourceLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type Paragraph ¶ added in v65.88.0
type Paragraph struct { // The part of the generated message that contains a citation. Text *string `mandatory:"true" json:"text"` // Where the text with a citation starts in the generated message. Start *int `mandatory:"true" json:"start"` // Where the text with a citation ends in the generated message. End *int `mandatory:"true" json:"end"` }
Paragraph The paragraph of the generated message that contains a citation.
func (Paragraph) ValidateEnumValue ¶ added in v65.88.0
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ParagraphCitation ¶ added in v65.88.0
type ParagraphCitation struct { Paragraph *Paragraph `mandatory:"true" json:"paragraph"` // A list of citations for the paragraph of the generated message. Citations []Citation `mandatory:"false" json:"citations"` }
ParagraphCitation The source of information for the paragraph of agent's response.
func (ParagraphCitation) String ¶ added in v65.88.0
func (m ParagraphCitation) String() string
func (ParagraphCitation) ValidateEnumValue ¶ added in v65.88.0
func (m ParagraphCitation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type PerformedAction ¶ added in v65.88.0
type PerformedAction interface { // The unique identifier for the action that has been performed. GetActionId() *string }
PerformedAction The base structure for an action that has already been performed.
type PerformedActionPerformedActionTypeEnum ¶ added in v65.88.0
type PerformedActionPerformedActionTypeEnum string
PerformedActionPerformedActionTypeEnum Enum with underlying type: string
const ( PerformedActionPerformedActionTypeHumanApprovalPerformedAction PerformedActionPerformedActionTypeEnum = "HUMAN_APPROVAL_PERFORMED_ACTION" PerformedActionPerformedActionTypeFunctionCallingPerformedAction PerformedActionPerformedActionTypeEnum = "FUNCTION_CALLING_PERFORMED_ACTION" )
Set of constants representing the allowable values for PerformedActionPerformedActionTypeEnum
func GetMappingPerformedActionPerformedActionTypeEnum ¶ added in v65.88.0
func GetMappingPerformedActionPerformedActionTypeEnum(val string) (PerformedActionPerformedActionTypeEnum, bool)
GetMappingPerformedActionPerformedActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPerformedActionPerformedActionTypeEnumValues ¶ added in v65.88.0
func GetPerformedActionPerformedActionTypeEnumValues() []PerformedActionPerformedActionTypeEnum
GetPerformedActionPerformedActionTypeEnumValues Enumerates the set of values for PerformedActionPerformedActionTypeEnum
type PlanningTrace ¶ added in v65.93.0
type PlanningTrace struct { // Unique identifier for the event (UUID). Key *string `mandatory:"false" json:"key"` // Identifier of the parent event, if applicable (UUID). ParentKey *string `mandatory:"false" json:"parentKey"` Source *SourceDetails `mandatory:"false" json:"source"` // The date and time that the trace was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Timestamp for when the event ended (In RFC 3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` // Input prompt to planning LLM. Input *string `mandatory:"false" json:"input"` // Output string from planning LLM. Output *string `mandatory:"false" json:"output"` // Details of model and its usage. Usage []Usage `mandatory:"false" json:"usage"` }
PlanningTrace Contains trace information related to planning at the platform.
func (PlanningTrace) GetKey ¶ added in v65.93.0
func (m PlanningTrace) GetKey() *string
GetKey returns Key
func (PlanningTrace) GetParentKey ¶ added in v65.93.0
func (m PlanningTrace) GetParentKey() *string
GetParentKey returns ParentKey
func (PlanningTrace) GetSource ¶ added in v65.93.0
func (m PlanningTrace) GetSource() *SourceDetails
GetSource returns Source
func (PlanningTrace) GetTimeCreated ¶ added in v65.93.0
func (m PlanningTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (PlanningTrace) GetTimeFinished ¶ added in v65.93.0
func (m PlanningTrace) GetTimeFinished() *common.SDKTime
GetTimeFinished returns TimeFinished
func (PlanningTrace) MarshalJSON ¶ added in v65.93.0
func (m PlanningTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (PlanningTrace) String ¶ added in v65.93.0
func (m PlanningTrace) String() string
func (PlanningTrace) ValidateEnumValue ¶ added in v65.93.0
func (m PlanningTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type RagToolOutput ¶ added in v65.96.0
type RagToolOutput struct { // Specifies the unique OCID of the tool. ToolId *string `mandatory:"true" json:"toolId"` // Specifies the generated answer from the RAG tool. Text *string `mandatory:"true" json:"text"` // Specifies the display name of the tool. ToolName *string `mandatory:"false" json:"toolName"` // Citations to data sources used for tool's generated answer. Citations []Citation `mandatory:"false" json:"citations"` // A list of citations used to generate the paragraphs of the tool's generated answer. ParagraphCitations []ParagraphCitation `mandatory:"false" json:"paragraphCitations"` }
RagToolOutput Specifies the output format for RAG tool, including the generated answer and citations.
func (RagToolOutput) GetToolId ¶ added in v65.96.0
func (m RagToolOutput) GetToolId() *string
GetToolId returns ToolId
func (RagToolOutput) GetToolName ¶ added in v65.96.0
func (m RagToolOutput) GetToolName() *string
GetToolName returns ToolName
func (RagToolOutput) MarshalJSON ¶ added in v65.96.0
func (m RagToolOutput) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (RagToolOutput) String ¶ added in v65.96.0
func (m RagToolOutput) String() string
func (RagToolOutput) ValidateEnumValue ¶ added in v65.96.0
func (m RagToolOutput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type RequiredAction ¶ added in v65.88.0
type RequiredAction interface { // The unique identifier for the action to be performed. GetActionId() *string }
RequiredAction Represents an action that needs to be performed by the user or client.
type RequiredActionRequiredActionTypeEnum ¶ added in v65.88.0
type RequiredActionRequiredActionTypeEnum string
RequiredActionRequiredActionTypeEnum Enum with underlying type: string
const ( RequiredActionRequiredActionTypeHumanApprovalRequiredAction RequiredActionRequiredActionTypeEnum = "HUMAN_APPROVAL_REQUIRED_ACTION" RequiredActionRequiredActionTypeFunctionCallingRequiredAction RequiredActionRequiredActionTypeEnum = "FUNCTION_CALLING_REQUIRED_ACTION" )
Set of constants representing the allowable values for RequiredActionRequiredActionTypeEnum
func GetMappingRequiredActionRequiredActionTypeEnum ¶ added in v65.88.0
func GetMappingRequiredActionRequiredActionTypeEnum(val string) (RequiredActionRequiredActionTypeEnum, bool)
GetMappingRequiredActionRequiredActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRequiredActionRequiredActionTypeEnumValues ¶ added in v65.88.0
func GetRequiredActionRequiredActionTypeEnumValues() []RequiredActionRequiredActionTypeEnum
GetRequiredActionRequiredActionTypeEnumValues Enumerates the set of values for RequiredActionRequiredActionTypeEnum
type RetrievalTrace ¶
type RetrievalTrace struct { // Unique identifier for the event (UUID). Key *string `mandatory:"false" json:"key"` // Identifier of the parent event, if applicable (UUID). ParentKey *string `mandatory:"false" json:"parentKey"` Source *SourceDetails `mandatory:"false" json:"source"` // The date and time that the trace was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Timestamp for when the event ended (In RFC 3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` // The agent's search string for getting the displayed information. RetrievalInput *string `mandatory:"false" json:"retrievalInput"` // A list of citations retrieved from data sources. Citations []Citation `mandatory:"false" json:"citations"` // Details of model and its usage. Usage []Usage `mandatory:"false" json:"usage"` }
RetrievalTrace The trace that displays the retrieval information.
func (RetrievalTrace) GetKey ¶ added in v65.93.0
func (m RetrievalTrace) GetKey() *string
GetKey returns Key
func (RetrievalTrace) GetParentKey ¶ added in v65.93.0
func (m RetrievalTrace) GetParentKey() *string
GetParentKey returns ParentKey
func (RetrievalTrace) GetSource ¶ added in v65.93.0
func (m RetrievalTrace) GetSource() *SourceDetails
GetSource returns Source
func (RetrievalTrace) GetTimeCreated ¶
func (m RetrievalTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (RetrievalTrace) GetTimeFinished ¶ added in v65.93.0
func (m RetrievalTrace) GetTimeFinished() *common.SDKTime
GetTimeFinished returns TimeFinished
func (RetrievalTrace) MarshalJSON ¶
func (m RetrievalTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (RetrievalTrace) String ¶
func (m RetrievalTrace) String() string
func (RetrievalTrace) ValidateEnumValue ¶
func (m RetrievalTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type RetrieveMetadataDetails ¶ added in v65.88.0
type RetrieveMetadataDetails struct { // List of metadata filters to narrow down the retrieved metadata Filters []MetadataFilter `mandatory:"false" json:"filters"` }
RetrieveMetadataDetails Details to retrieve metadata
func (RetrieveMetadataDetails) String ¶ added in v65.88.0
func (m RetrieveMetadataDetails) String() string
func (RetrieveMetadataDetails) ValidateEnumValue ¶ added in v65.88.0
func (m RetrieveMetadataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type RetrieveMetadataRequest ¶ added in v65.88.0
type RetrieveMetadataRequest struct { // A unique ID for the Knowledge Base. KnowledgeBaseId *string `mandatory:"true" contributesTo:"path" name:"knowledgeBaseId"` // Input for retrieve metadata. RetrieveMetadataDetails `contributesTo:"body"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // 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. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations. For example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
RetrieveMetadataRequest wrapper for the RetrieveMetadata operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/RetrieveMetadata.go.html to see an example of how to use RetrieveMetadataRequest.
func (RetrieveMetadataRequest) BinaryRequestBody ¶ added in v65.88.0
func (request RetrieveMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (RetrieveMetadataRequest) HTTPRequest ¶ added in v65.88.0
func (request RetrieveMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (RetrieveMetadataRequest) RetryPolicy ¶ added in v65.88.0
func (request RetrieveMetadataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (RetrieveMetadataRequest) String ¶ added in v65.88.0
func (request RetrieveMetadataRequest) String() string
func (RetrieveMetadataRequest) ValidateEnumValue ¶ added in v65.88.0
func (request RetrieveMetadataRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type RetrieveMetadataResponse ¶ added in v65.88.0
type RetrieveMetadataResponse struct { // The underlying http response RawResponse *http.Response // The []KnowledgeBaseMetadataSummary instance Items []KnowledgeBaseMetadataSummary `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
RetrieveMetadataResponse wrapper for the RetrieveMetadata operation
func (RetrieveMetadataResponse) HTTPResponse ¶ added in v65.88.0
func (response RetrieveMetadataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (RetrieveMetadataResponse) String ¶ added in v65.88.0
func (response RetrieveMetadataResponse) String() string
type Session ¶
type Session struct { // A unique ID for the session. This ID is immutable on creation. Id *string `mandatory:"true" json:"id"` // The date and time that the session started in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // A description of the session. Description *string `mandatory:"false" json:"description"` // A greeting message that the you receive when you start of a session. WelcomeMessage *string `mandatory:"false" json:"welcomeMessage"` // The date and time that the session was last updated in the format of an RFC3339 datetime string. TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` }
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.
func (Session) ValidateEnumValue ¶
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type SourceDetails ¶ added in v65.93.0
type SourceDetails struct { // Id of the source of the event. Key *string `mandatory:"false" json:"key"` // Name of the source of the event. Name *string `mandatory:"false" json:"name"` }
SourceDetails The details of source of the event.
func (SourceDetails) String ¶ added in v65.93.0
func (m SourceDetails) String() string
func (SourceDetails) ValidateEnumValue ¶ added in v65.93.0
func (m SourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type SourceLocation ¶
type SourceLocation interface { }
SourceLocation The location of the data files that the agent will use.
type SourceLocationSourceLocationTypeEnum ¶
type SourceLocationSourceLocationTypeEnum string
SourceLocationSourceLocationTypeEnum Enum with underlying type: string
const ( SourceLocationSourceLocationTypeObjectStorage SourceLocationSourceLocationTypeEnum = "OCI_OBJECT_STORAGE" SourceLocationSourceLocationTypeOpenSearch SourceLocationSourceLocationTypeEnum = "OCI_OPEN_SEARCH" SourceLocationSourceLocationTypeDatabase SourceLocationSourceLocationTypeEnum = "OCI_DATABASE" )
Set of constants representing the allowable values for SourceLocationSourceLocationTypeEnum
func GetMappingSourceLocationSourceLocationTypeEnum ¶
func GetMappingSourceLocationSourceLocationTypeEnum(val string) (SourceLocationSourceLocationTypeEnum, bool)
GetMappingSourceLocationSourceLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSourceLocationSourceLocationTypeEnumValues ¶
func GetSourceLocationSourceLocationTypeEnumValues() []SourceLocationSourceLocationTypeEnum
GetSourceLocationSourceLocationTypeEnumValues Enumerates the set of values for SourceLocationSourceLocationTypeEnum
type SqlResultFiles ¶ added in v65.96.0
type SqlResultFiles struct { // Specifies the path or URL to status metadata. StatusFile *string `mandatory:"false" json:"statusFile"` // Specifies the path or URL to the full SQL result data. DataFile *string `mandatory:"false" json:"dataFile"` }
SqlResultFiles Specifies file locations for SQL result data.
func (SqlResultFiles) String ¶ added in v65.96.0
func (m SqlResultFiles) String() string
func (SqlResultFiles) ValidateEnumValue ¶ added in v65.96.0
func (m SqlResultFiles) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type SqlToolOutput ¶ added in v65.96.0
type SqlToolOutput struct { // Specifies the unique OCID of the tool. ToolId *string `mandatory:"true" json:"toolId"` // Specifies the generated SQL query. GeneratedSql *string `mandatory:"true" json:"generatedSql"` // Specifies the display name of the tool. ToolName *string `mandatory:"false" json:"toolName"` // Represents preview rows from the SQL query. Result []interface{} `mandatory:"false" json:"result"` ResultFiles *SqlResultFiles `mandatory:"false" json:"resultFiles"` // Specifies optional metadata content. AdditionalInfo *string `mandatory:"false" json:"additionalInfo"` }
SqlToolOutput Specifies the output format for SQL tools, including the generated SQL statement and an optional preview of the query result.
func (SqlToolOutput) GetToolId ¶ added in v65.96.0
func (m SqlToolOutput) GetToolId() *string
GetToolId returns ToolId
func (SqlToolOutput) GetToolName ¶ added in v65.96.0
func (m SqlToolOutput) GetToolName() *string
GetToolName returns ToolName
func (SqlToolOutput) MarshalJSON ¶ added in v65.96.0
func (m SqlToolOutput) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (SqlToolOutput) String ¶ added in v65.96.0
func (m SqlToolOutput) String() string
func (SqlToolOutput) ValidateEnumValue ¶ added in v65.96.0
func (m SqlToolOutput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ToolInput ¶ added in v65.96.0
type ToolInput interface { // Unique OCID of the tool. GetToolId() *string }
ToolInput Base object for tool input parameters. The 'toolInputType' discriminator determines the specific input structure to be used.
type ToolInputToolInputTypeEnum ¶ added in v65.96.0
type ToolInputToolInputTypeEnum string
ToolInputToolInputTypeEnum Enum with underlying type: string
const (
ToolInputToolInputTypeGenericToolInput ToolInputToolInputTypeEnum = "GENERIC_TOOL_INPUT"
)
Set of constants representing the allowable values for ToolInputToolInputTypeEnum
func GetMappingToolInputToolInputTypeEnum ¶ added in v65.96.0
func GetMappingToolInputToolInputTypeEnum(val string) (ToolInputToolInputTypeEnum, bool)
GetMappingToolInputToolInputTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetToolInputToolInputTypeEnumValues ¶ added in v65.96.0
func GetToolInputToolInputTypeEnumValues() []ToolInputToolInputTypeEnum
GetToolInputToolInputTypeEnumValues Enumerates the set of values for ToolInputToolInputTypeEnum
type ToolInvocationTrace ¶ added in v65.93.0
type ToolInvocationTrace struct { // Unique identifier for the event (UUID). Key *string `mandatory:"false" json:"key"` // Identifier of the parent event, if applicable (UUID). ParentKey *string `mandatory:"false" json:"parentKey"` Source *SourceDetails `mandatory:"false" json:"source"` // The date and time that the trace was created in the format of an RFC3339 datetime string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Timestamp for when the event ended (In RFC 3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` // The ID of the selected tool based on the user query. ToolId *string `mandatory:"false" json:"toolId"` // The display name of the selected tool. ToolName *string `mandatory:"false" json:"toolName"` // The invocation details related to the selected tool. InvocationDetails *string `mandatory:"false" json:"invocationDetails"` }
ToolInvocationTrace The trace information about the tool selection from multiple tools.
func (ToolInvocationTrace) GetKey ¶ added in v65.93.0
func (m ToolInvocationTrace) GetKey() *string
GetKey returns Key
func (ToolInvocationTrace) GetParentKey ¶ added in v65.93.0
func (m ToolInvocationTrace) GetParentKey() *string
GetParentKey returns ParentKey
func (ToolInvocationTrace) GetSource ¶ added in v65.93.0
func (m ToolInvocationTrace) GetSource() *SourceDetails
GetSource returns Source
func (ToolInvocationTrace) GetTimeCreated ¶ added in v65.93.0
func (m ToolInvocationTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (ToolInvocationTrace) GetTimeFinished ¶ added in v65.93.0
func (m ToolInvocationTrace) GetTimeFinished() *common.SDKTime
GetTimeFinished returns TimeFinished
func (ToolInvocationTrace) MarshalJSON ¶ added in v65.93.0
func (m ToolInvocationTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (ToolInvocationTrace) String ¶ added in v65.93.0
func (m ToolInvocationTrace) String() string
func (ToolInvocationTrace) ValidateEnumValue ¶ added in v65.93.0
func (m ToolInvocationTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ToolOutput ¶ added in v65.96.0
type ToolOutput interface { // Specifies the unique OCID of the tool. GetToolId() *string // Specifies the display name of the tool. GetToolName() *string }
ToolOutput Base schema for tool outputs. Identified by `toolOutputType`, which determines the format of the output content.
type ToolOutputToolOutputTypeEnum ¶ added in v65.96.0
type ToolOutputToolOutputTypeEnum string
ToolOutputToolOutputTypeEnum Enum with underlying type: string
const ( ToolOutputToolOutputTypeGenericToolOutput ToolOutputToolOutputTypeEnum = "GENERIC_TOOL_OUTPUT" ToolOutputToolOutputTypeSqlToolOutput ToolOutputToolOutputTypeEnum = "SQL_TOOL_OUTPUT" ToolOutputToolOutputTypeRagToolOutput ToolOutputToolOutputTypeEnum = "RAG_TOOL_OUTPUT" )
Set of constants representing the allowable values for ToolOutputToolOutputTypeEnum
func GetMappingToolOutputToolOutputTypeEnum ¶ added in v65.96.0
func GetMappingToolOutputToolOutputTypeEnum(val string) (ToolOutputToolOutputTypeEnum, bool)
GetMappingToolOutputToolOutputTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetToolOutputToolOutputTypeEnumValues ¶ added in v65.96.0
func GetToolOutputToolOutputTypeEnumValues() []ToolOutputToolOutputTypeEnum
GetToolOutputToolOutputTypeEnumValues Enumerates the set of values for ToolOutputToolOutputTypeEnum
type Trace ¶
type Trace interface { // Unique identifier for the event (UUID). GetKey() *string // Identifier of the parent event, if applicable (UUID). GetParentKey() *string GetSource() *SourceDetails // The date and time that the trace was created in the format of an RFC3339 datetime string. GetTimeCreated() *common.SDKTime // Timestamp for when the event ended (In RFC 3339). GetTimeFinished() *common.SDKTime }
Trace The trace that displays the internal progression, such as reasoning and actions during an execution.
type TraceTraceTypeEnum ¶
type TraceTraceTypeEnum string
TraceTraceTypeEnum Enum with underlying type: string
const ( TraceTraceTypeErrorTrace TraceTraceTypeEnum = "ERROR_TRACE" TraceTraceTypeRetrievalTrace TraceTraceTypeEnum = "RETRIEVAL_TRACE" TraceTraceTypeGenerationTrace TraceTraceTypeEnum = "GENERATION_TRACE" TraceTraceTypeToolInvocationTrace TraceTraceTypeEnum = "TOOL_INVOCATION_TRACE" TraceTraceTypePlanningTrace TraceTraceTypeEnum = "PLANNING_TRACE" TraceTraceTypeExecutionTrace TraceTraceTypeEnum = "EXECUTION_TRACE" )
Set of constants representing the allowable values for TraceTraceTypeEnum
func GetMappingTraceTraceTypeEnum ¶
func GetMappingTraceTraceTypeEnum(val string) (TraceTraceTypeEnum, bool)
GetMappingTraceTraceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTraceTraceTypeEnumValues ¶
func GetTraceTraceTypeEnumValues() []TraceTraceTypeEnum
GetTraceTraceTypeEnumValues Enumerates the set of values for TraceTraceTypeEnum
type UpdateSessionDetails ¶
type UpdateSessionDetails struct { // The name of the session. A session names doesn't have to be unique and you can change the session name later. DisplayName *string `mandatory:"false" json:"displayName"` // A description of the session. Description *string `mandatory:"false" json:"description"` }
UpdateSessionDetails Information about the updated session.
func (UpdateSessionDetails) String ¶
func (m UpdateSessionDetails) String() string
func (UpdateSessionDetails) ValidateEnumValue ¶
func (m UpdateSessionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type UpdateSessionRequest ¶
type UpdateSessionRequest struct { // A unique ID for the endpoint. AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"` // A unique ID for the session. SessionId *string `mandatory:"true" contributesTo:"path" name:"sessionId"` // Details to update an agent session. UpdateSessionDetails `contributesTo:"body"` // 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. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
UpdateSessionRequest wrapper for the UpdateSession operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagentruntime/UpdateSession.go.html to see an example of how to use UpdateSessionRequest.
func (UpdateSessionRequest) BinaryRequestBody ¶
func (request UpdateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (UpdateSessionRequest) HTTPRequest ¶
func (request UpdateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateSessionRequest) RetryPolicy ¶
func (request UpdateSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateSessionRequest) String ¶
func (request UpdateSessionRequest) String() string
func (UpdateSessionRequest) ValidateEnumValue ¶
func (request UpdateSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type UpdateSessionResponse ¶
type UpdateSessionResponse struct { // The underlying http response RawResponse *http.Response // The Session instance Session `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
UpdateSessionResponse wrapper for the UpdateSession operation
func (UpdateSessionResponse) HTTPResponse ¶
func (response UpdateSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateSessionResponse) String ¶
func (response UpdateSessionResponse) String() string
type Usage ¶ added in v65.93.0
type Usage struct { ModelDetails *ModelDetails `mandatory:"false" json:"modelDetails"` UsageDetails *UsageDetails `mandatory:"false" json:"usageDetails"` }
Usage Details of usage.
func (Usage) ValidateEnumValue ¶ added in v65.93.0
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type UsageDetails ¶ added in v65.93.0
type UsageDetails struct { // Number of input tokens. InputTokenCount *int `mandatory:"false" json:"inputTokenCount"` // Number of output tokens. OutputTokenCount *int `mandatory:"false" json:"outputTokenCount"` // Number of input characters. InputCharCount *int `mandatory:"false" json:"inputCharCount"` // Number of output characters. OutputCharCount *int `mandatory:"false" json:"outputCharCount"` }
UsageDetails Usage details.
func (UsageDetails) String ¶ added in v65.93.0
func (m UsageDetails) String() string
func (UsageDetails) ValidateEnumValue ¶ added in v65.93.0
func (m UsageDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Source Files
¶
- chat_details.go
- chat_request_response.go
- chat_result.go
- citation.go
- create_session_details.go
- create_session_request_response.go
- delete_session_request_response.go
- error_trace.go
- execution_trace.go
- function_call.go
- function_calling_performed_action.go
- function_calling_required_action.go
- generation_trace.go
- generativeaiagentruntime_client.go
- generic_tool_input.go
- generic_tool_output.go
- get_session_request_response.go
- human_approval_performed_action.go
- human_approval_required_action.go
- knowledge_base_metadata_summary.go
- knowledge_base_metadata_value.go
- message.go
- message_content.go
- metadata_filter.go
- model_details.go
- model_params.go
- oci_database_source_location.go
- oci_object_storage_source_location.go
- oci_open_search_source_location.go
- paragraph.go
- paragraph_citation.go
- performed_action.go
- planning_trace.go
- rag_tool_output.go
- required_action.go
- retrieval_trace.go
- retrieve_metadata_details.go
- retrieve_metadata_request_response.go
- session.go
- source_details.go
- source_location.go
- sql_result_files.go
- sql_tool_output.go
- tool_input.go
- tool_invocation_trace.go
- tool_output.go
- trace.go
- update_session_details.go
- update_session_request_response.go
- usage.go
- usage_details.go