generativeaiagentruntime

package
v65.75.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetMessageRoleEnumStringValues 

func GetMessageRoleEnumStringValues() []string

GetMessageRoleEnumStringValues Enumerates the set of values in String for MessageRoleEnum

func GetSourceLocationSourceLocationTypeEnumStringValues 

func GetSourceLocationSourceLocationTypeEnumStringValues() []string

GetSourceLocationSourceLocationTypeEnumStringValues Enumerates the set of values in String for SourceLocationSourceLocationTypeEnum

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:"true" 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"`
}

ChatDetails Chat details.

func (ChatDetails) String 

func (m ChatDetails) String() string

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.cloud.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"`
}

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"`
}

Citation The citation displays the location of source text that is the agent uses to create the responses.

func (Citation) String 

func (m Citation) String() string

func (*Citation) UnmarshalJSON 

func (m *Citation) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Citation) ValidateEnumValue 

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

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.cloud.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.cloud.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 {

	// 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"`
}

ErrorTrace The trace information about the error.

func (ErrorTrace) GetTimeCreated 

func (m ErrorTrace) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

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 GenerationTrace 

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"`
}

GenerationTrace The trace information about the generated response.

func (GenerationTrace) GetTimeCreated 

func (m GenerationTrace) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

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.cloud.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.cloud.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.cloud.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.cloud.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) 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.cloud.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 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.cloud.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 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) String 

func (m Message) String() string

func (Message) ValidateEnumValue 

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

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"`
}

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 OciDatabaseSourceLocation 

type OciDatabaseSourceLocation struct {

	// The OCID of the OCI Database Tools Connection (https://docs.cloud.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 RetrievalTrace 

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"`
}

RetrievalTrace The trace that displays the retrieval information.

func (RetrievalTrace) GetTimeCreated 

func (m RetrievalTrace) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

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 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) String 

func (m Session) String() string

func (Session) ValidateEnumValue 

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

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 Trace 

type Trace interface {

	// The date and time that the trace was created in the format of an RFC3339 datetime string.
	GetTimeCreated() *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"
)

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.cloud.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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.