func GetHumanApprovalPerformedActionChosenOptionEnumStringValues() []string
GetHumanApprovalPerformedActionChosenOptionEnumStringValues Enumerates the set of values in String for HumanApprovalPerformedActionChosenOptionEnum
func GetMessageRoleEnumStringValues() []string
GetMessageRoleEnumStringValues Enumerates the set of values in String for MessageRoleEnum
func GetPerformedActionPerformedActionTypeEnumStringValues() []string
GetPerformedActionPerformedActionTypeEnumStringValues Enumerates the set of values in String for PerformedActionPerformedActionTypeEnum
func GetRequiredActionRequiredActionTypeEnumStringValues() []string
GetRequiredActionRequiredActionTypeEnumStringValues Enumerates the set of values in String for RequiredActionRequiredActionTypeEnum
func GetSourceLocationSourceLocationTypeEnumStringValues() []string
GetSourceLocationSourceLocationTypeEnumStringValues Enumerates the set of values in String for SourceLocationSourceLocationTypeEnum
func GetTraceTraceTypeEnumStringValues() []string
GetTraceTraceTypeEnumStringValues Enumerates the set of values in String for TraceTraceTypeEnum
ChatDetails Chat details for managing user interactions and tool executions.
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.
ToolParameters map[string]string `mandatory:"false" json:"toolParameters"`
// A list of actions that have been performed based on prior required actions.
PerformedActions []PerformedAction `mandatory:"false" json:"performedActions"`
}
func (m ChatDetails) String() string
func (m *ChatDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
ChatRequest wrapper for the Chat operation
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.
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
}
func (request ChatRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChatRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChatRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChatRequest) String() string
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
ChatResponse wrapper for the Chat operation
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"`
}
func (response ChatResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChatResponse) String() string
ChatResult The response of a chat request.
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.
ToolResults map[string]string `mandatory:"false" json:"toolResults"`
// 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"`
}
func (m ChatResult) String() string
func (m *ChatResult) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
Citation The source of information for the agent's response.
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"`
}
func (m Citation) String() string
func (m *Citation) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Citation) 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
CreateSessionDetails Information about the new session.
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"`
}
func (m CreateSessionDetails) String() string
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
CreateSessionRequest wrapper for the CreateSession operation
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.
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
}
func (request CreateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSessionRequest) String() string
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
CreateSessionResponse wrapper for the CreateSession operation
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"`
}
func (response CreateSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSessionResponse) String() string
DeleteSessionRequest wrapper for the DeleteSession operation
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.
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
}
func (request DeleteSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSessionRequest) String() string
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
DeleteSessionResponse wrapper for the DeleteSession operation
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"`
}
func (response DeleteSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSessionResponse) String() string
ErrorTrace The trace information about the error.
type ErrorTrace struct {
// The date and time that the trace was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The error message in this trace.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
}
func (m ErrorTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ErrorTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ErrorTrace) String() string
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
FunctionCall Represent a function call the client need to execute in order to fulfill the required action.
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"`
}
func (m FunctionCall) String() string
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
FunctionCallingPerformedAction Represents an action for recording the result of a function call.
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"`
}
func (m FunctionCallingPerformedAction) GetActionId() *string
GetActionId returns ActionId
func (m FunctionCallingPerformedAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FunctionCallingPerformedAction) String() string
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
FunctionCallingRequiredAction Represents an action for submitting function call outputs.
type FunctionCallingRequiredAction struct {
// The unique identifier for the action to be performed.
ActionId *string `mandatory:"true" json:"actionId"`
FunctionCall *FunctionCall `mandatory:"true" json:"functionCall"`
}
func (m FunctionCallingRequiredAction) GetActionId() *string
GetActionId returns ActionId
func (m FunctionCallingRequiredAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FunctionCallingRequiredAction) String() string
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
GenerationTrace The trace information about the generated response.
type GenerationTrace struct {
// The date and time that the trace was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The generated response that's returned to the user.
Generation *string `mandatory:"false" json:"generation"`
}
func (m GenerationTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m GenerationTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GenerationTrace) String() string
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
GenerativeAiAgentRuntimeClient a client for GenerativeAiAgentRuntime
type GenerativeAiAgentRuntimeClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client GenerativeAiAgentRuntimeClient) Chat(ctx context.Context, request ChatRequest) (response ChatResponse, err error)
Chat Chat on endpoint with provided messages.
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 (client *GenerativeAiAgentRuntimeClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
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 (client GenerativeAiAgentRuntimeClient) DeleteSession(ctx context.Context, request DeleteSessionRequest) (response DeleteSessionResponse, err error)
DeleteSession Delete a session and all its associated information.
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 (client GenerativeAiAgentRuntimeClient) GetSession(ctx context.Context, request GetSessionRequest) (response GetSessionResponse, err error)
GetSession Return the session resource identified by the session ID.
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 (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.
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 (client *GenerativeAiAgentRuntimeClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GenerativeAiAgentRuntimeClient) UpdateSession(ctx context.Context, request UpdateSessionRequest) (response UpdateSessionResponse, err error)
UpdateSession Update session metadata, including but not limited to description, tags.
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()
GetSessionRequest wrapper for the GetSession operation
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.
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
}
func (request GetSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSessionRequest) String() string
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
GetSessionResponse wrapper for the GetSession operation
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"`
}
func (response GetSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSessionResponse) String() string
HumanApprovalPerformedAction An action describing user approval to the agent.
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"`
}
func (m HumanApprovalPerformedAction) GetActionId() *string
GetActionId returns ActionId
func (m HumanApprovalPerformedAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HumanApprovalPerformedAction) String() string
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
HumanApprovalPerformedActionChosenOptionEnum Enum with underlying type: string
type HumanApprovalPerformedActionChosenOptionEnum string
Set of constants representing the allowable values for HumanApprovalPerformedActionChosenOptionEnum
const (
HumanApprovalPerformedActionChosenOptionApprove HumanApprovalPerformedActionChosenOptionEnum = "APPROVE"
HumanApprovalPerformedActionChosenOptionDeny HumanApprovalPerformedActionChosenOptionEnum = "DENY"
)
func GetHumanApprovalPerformedActionChosenOptionEnumValues() []HumanApprovalPerformedActionChosenOptionEnum
GetHumanApprovalPerformedActionChosenOptionEnumValues Enumerates the set of values for HumanApprovalPerformedActionChosenOptionEnum
func GetMappingHumanApprovalPerformedActionChosenOptionEnum(val string) (HumanApprovalPerformedActionChosenOptionEnum, bool)
GetMappingHumanApprovalPerformedActionChosenOptionEnum performs case Insensitive comparison on enum value and return the desired enum
KnowledgeBaseMetadataSummary Represents metadata about a field including its name, type, supported operations, and possible values.
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"`
}
func (m KnowledgeBaseMetadataSummary) String() string
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
KnowledgeBaseMetadataValue Represents a metadata value and the number of appearances in knowledge base.
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"`
}
func (m KnowledgeBaseMetadataValue) String() string
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
Message The Message resource generated by the agent.
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"`
}
func (m Message) String() string
func (m Message) 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
MessageContent The content of the message.
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"`
}
func (m MessageContent) String() string
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
MessageRoleEnum Enum with underlying type: string
type MessageRoleEnum string
Set of constants representing the allowable values for MessageRoleEnum
const (
MessageRoleUser MessageRoleEnum = "USER"
MessageRoleAgent MessageRoleEnum = "AGENT"
)
func GetMappingMessageRoleEnum(val string) (MessageRoleEnum, bool)
GetMappingMessageRoleEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMessageRoleEnumValues() []MessageRoleEnum
GetMessageRoleEnumValues Enumerates the set of values for MessageRoleEnum
MetadataFilter Filter for retrieving specific metadata
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"`
}
func (m MetadataFilter) String() string
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
OciDatabaseSourceLocation The location of the OCI Database that the agent will use.
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"`
}
func (m OciDatabaseSourceLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciDatabaseSourceLocation) String() string
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
OciObjectStorageSourceLocation The OCI Object Storage that contains the data files.
type OciObjectStorageSourceLocation struct {
// The URL of the OCI Object Storage data source.
Url *string `mandatory:"false" json:"url"`
}
func (m OciObjectStorageSourceLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciObjectStorageSourceLocation) String() string
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
OciOpenSearchSourceLocation The location of the OCI Search with OpenSearch that the agent will use.
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"`
}
func (m OciOpenSearchSourceLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciOpenSearchSourceLocation) String() string
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
Paragraph The paragraph of the generated message that contains a citation.
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"`
}
func (m Paragraph) String() string
func (m Paragraph) 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
ParagraphCitation The source of information for the paragraph of agent's response.
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"`
}
func (m ParagraphCitation) String() string
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
PerformedAction The base structure for an action that has already been performed.
type PerformedAction interface {
// The unique identifier for the action that has been performed.
GetActionId() *string
}
PerformedActionPerformedActionTypeEnum Enum with underlying type: string
type PerformedActionPerformedActionTypeEnum string
Set of constants representing the allowable values for PerformedActionPerformedActionTypeEnum
const (
PerformedActionPerformedActionTypeHumanApprovalPerformedAction PerformedActionPerformedActionTypeEnum = "HUMAN_APPROVAL_PERFORMED_ACTION"
PerformedActionPerformedActionTypeFunctionCallingPerformedAction PerformedActionPerformedActionTypeEnum = "FUNCTION_CALLING_PERFORMED_ACTION"
)
func GetMappingPerformedActionPerformedActionTypeEnum(val string) (PerformedActionPerformedActionTypeEnum, bool)
GetMappingPerformedActionPerformedActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPerformedActionPerformedActionTypeEnumValues() []PerformedActionPerformedActionTypeEnum
GetPerformedActionPerformedActionTypeEnumValues Enumerates the set of values for PerformedActionPerformedActionTypeEnum
RequiredAction Represents an action that needs to be performed by the user or client.
type RequiredAction interface {
// The unique identifier for the action to be performed.
GetActionId() *string
}
RequiredActionRequiredActionTypeEnum Enum with underlying type: string
type RequiredActionRequiredActionTypeEnum string
Set of constants representing the allowable values for RequiredActionRequiredActionTypeEnum
const (
RequiredActionRequiredActionTypeHumanApprovalRequiredAction RequiredActionRequiredActionTypeEnum = "HUMAN_APPROVAL_REQUIRED_ACTION"
RequiredActionRequiredActionTypeFunctionCallingRequiredAction RequiredActionRequiredActionTypeEnum = "FUNCTION_CALLING_REQUIRED_ACTION"
)
func GetMappingRequiredActionRequiredActionTypeEnum(val string) (RequiredActionRequiredActionTypeEnum, bool)
GetMappingRequiredActionRequiredActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRequiredActionRequiredActionTypeEnumValues() []RequiredActionRequiredActionTypeEnum
GetRequiredActionRequiredActionTypeEnumValues Enumerates the set of values for RequiredActionRequiredActionTypeEnum
RetrievalTrace The trace that displays the retrieval information.
type RetrievalTrace struct {
// The date and time that the trace was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// 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"`
}
func (m RetrievalTrace) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m RetrievalTrace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RetrievalTrace) String() string
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
RetrieveMetadataDetails Details to retrieve metadata
type RetrieveMetadataDetails struct {
// List of metadata filters to narrow down the retrieved metadata
Filters []MetadataFilter `mandatory:"false" json:"filters"`
}
func (m RetrieveMetadataDetails) String() string
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
RetrieveMetadataRequest wrapper for the RetrieveMetadata operation
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.
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
}
func (request RetrieveMetadataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveMetadataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveMetadataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveMetadataRequest) String() string
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
RetrieveMetadataResponse wrapper for the RetrieveMetadata operation
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"`
}
func (response RetrieveMetadataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveMetadataResponse) String() string
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.
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"`
}
func (m Session) String() string
func (m Session) 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
SourceLocation The location of the data files that the agent will use.
type SourceLocation interface {
}
SourceLocationSourceLocationTypeEnum Enum with underlying type: string
type SourceLocationSourceLocationTypeEnum string
Set of constants representing the allowable values for SourceLocationSourceLocationTypeEnum
const (
SourceLocationSourceLocationTypeObjectStorage SourceLocationSourceLocationTypeEnum = "OCI_OBJECT_STORAGE"
SourceLocationSourceLocationTypeOpenSearch SourceLocationSourceLocationTypeEnum = "OCI_OPEN_SEARCH"
SourceLocationSourceLocationTypeDatabase SourceLocationSourceLocationTypeEnum = "OCI_DATABASE"
)
func GetMappingSourceLocationSourceLocationTypeEnum(val string) (SourceLocationSourceLocationTypeEnum, bool)
GetMappingSourceLocationSourceLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSourceLocationSourceLocationTypeEnumValues() []SourceLocationSourceLocationTypeEnum
GetSourceLocationSourceLocationTypeEnumValues Enumerates the set of values for SourceLocationSourceLocationTypeEnum
Trace The trace that displays the internal progression, such as reasoning and actions during an execution.
type Trace interface {
// The date and time that the trace was created in the format of an RFC3339 datetime string.
GetTimeCreated() *common.SDKTime
}
TraceTraceTypeEnum Enum with underlying type: string
type TraceTraceTypeEnum string
Set of constants representing the allowable values for TraceTraceTypeEnum
const (
TraceTraceTypeErrorTrace TraceTraceTypeEnum = "ERROR_TRACE"
TraceTraceTypeRetrievalTrace TraceTraceTypeEnum = "RETRIEVAL_TRACE"
TraceTraceTypeGenerationTrace TraceTraceTypeEnum = "GENERATION_TRACE"
)
func GetMappingTraceTraceTypeEnum(val string) (TraceTraceTypeEnum, bool)
GetMappingTraceTraceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTraceTraceTypeEnumValues() []TraceTraceTypeEnum
GetTraceTraceTypeEnumValues Enumerates the set of values for TraceTraceTypeEnum
UpdateSessionDetails Information about the updated session.
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"`
}
func (m UpdateSessionDetails) String() string
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
UpdateSessionRequest wrapper for the UpdateSession operation
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.
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
}
func (request UpdateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSessionRequest) String() string
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
UpdateSessionResponse wrapper for the UpdateSession operation
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"`
}
func (response UpdateSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSessionResponse) String() string