func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAgentEndpointLifecycleStateEnumStringValues() []string
GetAgentEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for AgentEndpointLifecycleStateEnum
func GetAgentLifecycleStateEnumStringValues() []string
GetAgentLifecycleStateEnumStringValues Enumerates the set of values in String for AgentLifecycleStateEnum
func GetDataIngestionJobLifecycleStateEnumStringValues() []string
GetDataIngestionJobLifecycleStateEnumStringValues Enumerates the set of values in String for DataIngestionJobLifecycleStateEnum
func GetDataSourceConfigDataSourceConfigTypeEnumStringValues() []string
GetDataSourceConfigDataSourceConfigTypeEnumStringValues Enumerates the set of values in String for DataSourceConfigDataSourceConfigTypeEnum
func GetDataSourceLifecycleStateEnumStringValues() []string
GetDataSourceLifecycleStateEnumStringValues Enumerates the set of values in String for DataSourceLifecycleStateEnum
func GetDatabaseConnectionConnectionTypeEnumStringValues() []string
GetDatabaseConnectionConnectionTypeEnumStringValues Enumerates the set of values in String for DatabaseConnectionConnectionTypeEnum
func GetIndexConfigIndexConfigTypeEnumStringValues() []string
GetIndexConfigIndexConfigTypeEnumStringValues Enumerates the set of values in String for IndexConfigIndexConfigTypeEnum
func GetKnowledgeBaseLifecycleStateEnumStringValues() []string
GetKnowledgeBaseLifecycleStateEnumStringValues Enumerates the set of values in String for KnowledgeBaseLifecycleStateEnum
func GetListAgentEndpointsSortByEnumStringValues() []string
GetListAgentEndpointsSortByEnumStringValues Enumerates the set of values in String for ListAgentEndpointsSortByEnum
func GetListAgentEndpointsSortOrderEnumStringValues() []string
GetListAgentEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListAgentEndpointsSortOrderEnum
func GetListAgentsSortByEnumStringValues() []string
GetListAgentsSortByEnumStringValues Enumerates the set of values in String for ListAgentsSortByEnum
func GetListAgentsSortOrderEnumStringValues() []string
GetListAgentsSortOrderEnumStringValues Enumerates the set of values in String for ListAgentsSortOrderEnum
func GetListDataIngestionJobsSortByEnumStringValues() []string
GetListDataIngestionJobsSortByEnumStringValues Enumerates the set of values in String for ListDataIngestionJobsSortByEnum
func GetListDataIngestionJobsSortOrderEnumStringValues() []string
GetListDataIngestionJobsSortOrderEnumStringValues Enumerates the set of values in String for ListDataIngestionJobsSortOrderEnum
func GetListDataSourcesSortByEnumStringValues() []string
GetListDataSourcesSortByEnumStringValues Enumerates the set of values in String for ListDataSourcesSortByEnum
func GetListDataSourcesSortOrderEnumStringValues() []string
GetListDataSourcesSortOrderEnumStringValues Enumerates the set of values in String for ListDataSourcesSortOrderEnum
func GetListKnowledgeBasesSortByEnumStringValues() []string
GetListKnowledgeBasesSortByEnumStringValues Enumerates the set of values in String for ListKnowledgeBasesSortByEnum
func GetListKnowledgeBasesSortOrderEnumStringValues() []string
GetListKnowledgeBasesSortOrderEnumStringValues Enumerates the set of values in String for ListKnowledgeBasesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSecretDetailTypeEnumStringValues() []string
GetSecretDetailTypeEnumStringValues Enumerates the set of values in String for SecretDetailTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Agent **Agent** An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI Agents supports retrieval-augmented generation (RAG) agents. A RAG agent connects to a data source, retrieves data, and augments model responses with the information from the data sources to generate more relevant responses. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type Agent struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the agent was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the agent.
LifecycleState AgentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description about the agent.
Description *string `mandatory:"false" json:"description"`
// List of OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent.
KnowledgeBaseIds []string `mandatory:"false" json:"knowledgeBaseIds"`
// Details about purpose and responsibility of the agent
WelcomeMessage *string `mandatory:"false" json:"welcomeMessage"`
// The date and time the agent was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the agent in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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 Agent) String() string
func (m Agent) 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
AgentCollection **AgentCollection** Results of an agent search. Contains both AgentSummary items and other information, such as metadata.
type AgentCollection struct {
// List of agents.
Items []AgentSummary `mandatory:"true" json:"items"`
}
func (m AgentCollection) String() string
func (m AgentCollection) 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
AgentEndpoint **AgentEndpoint** The endpoint to access a deployed agent. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type AgentEndpoint struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the agent that this endpoint is associated with.
AgentId *string `mandatory:"true" json:"agentId"`
// The date and time the AgentEndpoint was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the endpoint.
LifecycleState AgentEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the endpoint.
Description *string `mandatory:"false" json:"description"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
// Whether to show traces in the chat result.
ShouldEnableTrace *bool `mandatory:"false" json:"shouldEnableTrace"`
// Whether to show citations in the chat result.
ShouldEnableCitation *bool `mandatory:"false" json:"shouldEnableCitation"`
// Whether or not to enable Session-based chat.
ShouldEnableSession *bool `mandatory:"false" json:"shouldEnableSession"`
SessionConfig *SessionConfig `mandatory:"false" json:"sessionConfig"`
// The date and time the endpoint was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the endpoint in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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 AgentEndpoint) String() string
func (m AgentEndpoint) 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
AgentEndpointCollection **AgentEndpointCollection** Results of an agentEndpoint search. Contains both AgentEndpointSummary items and other information, such as metadata.
type AgentEndpointCollection struct {
// List of endpoints.
Items []AgentEndpointSummary `mandatory:"true" json:"items"`
}
func (m AgentEndpointCollection) String() string
func (m AgentEndpointCollection) 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
AgentEndpointLifecycleStateEnum Enum with underlying type: string
type AgentEndpointLifecycleStateEnum string
Set of constants representing the allowable values for AgentEndpointLifecycleStateEnum
const (
AgentEndpointLifecycleStateCreating AgentEndpointLifecycleStateEnum = "CREATING"
AgentEndpointLifecycleStateUpdating AgentEndpointLifecycleStateEnum = "UPDATING"
AgentEndpointLifecycleStateActive AgentEndpointLifecycleStateEnum = "ACTIVE"
AgentEndpointLifecycleStateDeleting AgentEndpointLifecycleStateEnum = "DELETING"
AgentEndpointLifecycleStateDeleted AgentEndpointLifecycleStateEnum = "DELETED"
AgentEndpointLifecycleStateFailed AgentEndpointLifecycleStateEnum = "FAILED"
)
func GetAgentEndpointLifecycleStateEnumValues() []AgentEndpointLifecycleStateEnum
GetAgentEndpointLifecycleStateEnumValues Enumerates the set of values for AgentEndpointLifecycleStateEnum
func GetMappingAgentEndpointLifecycleStateEnum(val string) (AgentEndpointLifecycleStateEnum, bool)
GetMappingAgentEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AgentEndpointSummary **AgentEndpointSummary** Summary information about an endpoint.
type AgentEndpointSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the AgentEndpoint.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the agent that this AgentEndpoint is associated with.
AgentId *string `mandatory:"true" json:"agentId"`
// The date and time the endpoint was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the endpoint.
LifecycleState AgentEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the endpoint.
Description *string `mandatory:"false" json:"description"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
// Whether to show traces in the chat result.
ShouldEnableTrace *bool `mandatory:"false" json:"shouldEnableTrace"`
// Whether to show citations in the chat result.
ShouldEnableCitation *bool `mandatory:"false" json:"shouldEnableCitation"`
// Whether or not to enable Session-based chat.
ShouldEnableSession *bool `mandatory:"false" json:"shouldEnableSession"`
SessionConfig *SessionConfig `mandatory:"false" json:"sessionConfig"`
// The date and time the AgentEndpoint was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the endpoint in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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 AgentEndpointSummary) String() string
func (m AgentEndpointSummary) 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
AgentLifecycleStateEnum Enum with underlying type: string
type AgentLifecycleStateEnum string
Set of constants representing the allowable values for AgentLifecycleStateEnum
const (
AgentLifecycleStateCreating AgentLifecycleStateEnum = "CREATING"
AgentLifecycleStateUpdating AgentLifecycleStateEnum = "UPDATING"
AgentLifecycleStateActive AgentLifecycleStateEnum = "ACTIVE"
AgentLifecycleStateDeleting AgentLifecycleStateEnum = "DELETING"
AgentLifecycleStateDeleted AgentLifecycleStateEnum = "DELETED"
AgentLifecycleStateFailed AgentLifecycleStateEnum = "FAILED"
)
func GetAgentLifecycleStateEnumValues() []AgentLifecycleStateEnum
GetAgentLifecycleStateEnumValues Enumerates the set of values for AgentLifecycleStateEnum
func GetMappingAgentLifecycleStateEnum(val string) (AgentLifecycleStateEnum, bool)
GetMappingAgentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AgentSummary **AgentSummary** Summary information about an agent.
type AgentSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Agent.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the agent was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the agent.
LifecycleState AgentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description about the agent.
Description *string `mandatory:"false" json:"description"`
// List of OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent.
KnowledgeBaseIds []string `mandatory:"false" json:"knowledgeBaseIds"`
// Details about purpose and responsibility of the agent
WelcomeMessage *string `mandatory:"false" json:"welcomeMessage"`
// The date and time the agent was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the agent in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
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 AgentSummary) String() string
func (m AgentSummary) 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
BasicAuthSecret **BasicAuthSecret** The details of Basic authentication configured as in OpenSearch.
type BasicAuthSecret struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
VaultSecretId *string `mandatory:"true" json:"vaultSecretId"`
}
func (m BasicAuthSecret) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BasicAuthSecret) String() string
func (m BasicAuthSecret) 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
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) 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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse 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 CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeAgentCompartmentDetails **ChangeAgentCompartmentDetails** The configuration details for the move operation.
type ChangeAgentCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the agent to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeAgentCompartmentDetails) String() string
func (m ChangeAgentCompartmentDetails) 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
ChangeAgentCompartmentRequest wrapper for the ChangeAgentCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ChangeAgentCompartment.go.html to see an example of how to use ChangeAgentCompartmentRequest.
type ChangeAgentCompartmentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
AgentId *string `mandatory:"true" contributesTo:"path" name:"agentId"`
// The information to be updated.
ChangeAgentCompartmentDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed 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 ChangeAgentCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAgentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAgentCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAgentCompartmentRequest) String() string
func (request ChangeAgentCompartmentRequest) 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
ChangeAgentCompartmentResponse wrapper for the ChangeAgentCompartment operation
type ChangeAgentCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 ChangeAgentCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAgentCompartmentResponse) String() string
ChangeAgentEndpointCompartmentDetails **ChangeAgentEndpointCompartmentDetails** The configuration details for the move operation.
type ChangeAgentEndpointCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the endpoint to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeAgentEndpointCompartmentDetails) String() string
func (m ChangeAgentEndpointCompartmentDetails) 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
ChangeAgentEndpointCompartmentRequest wrapper for the ChangeAgentEndpointCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ChangeAgentEndpointCompartment.go.html to see an example of how to use ChangeAgentEndpointCompartmentRequest.
type ChangeAgentEndpointCompartmentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"`
// The information to be updated.
ChangeAgentEndpointCompartmentDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed 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 ChangeAgentEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAgentEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAgentEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAgentEndpointCompartmentRequest) String() string
func (request ChangeAgentEndpointCompartmentRequest) 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
ChangeAgentEndpointCompartmentResponse wrapper for the ChangeAgentEndpointCompartment operation
type ChangeAgentEndpointCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 ChangeAgentEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAgentEndpointCompartmentResponse) String() string
ChangeKnowledgeBaseCompartmentDetails **ChangeKnowledgeBaseCompartmentDetails** The configuration details for the move operation.
type ChangeKnowledgeBaseCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the KnowledgeBase to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeKnowledgeBaseCompartmentDetails) String() string
func (m ChangeKnowledgeBaseCompartmentDetails) 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
ChangeKnowledgeBaseCompartmentRequest wrapper for the ChangeKnowledgeBaseCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ChangeKnowledgeBaseCompartment.go.html to see an example of how to use ChangeKnowledgeBaseCompartmentRequest.
type ChangeKnowledgeBaseCompartmentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
KnowledgeBaseId *string `mandatory:"true" contributesTo:"path" name:"knowledgeBaseId"`
// The information to be updated.
ChangeKnowledgeBaseCompartmentDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed 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 ChangeKnowledgeBaseCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeKnowledgeBaseCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeKnowledgeBaseCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeKnowledgeBaseCompartmentRequest) String() string
func (request ChangeKnowledgeBaseCompartmentRequest) 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
ChangeKnowledgeBaseCompartmentResponse wrapper for the ChangeKnowledgeBaseCompartment operation
type ChangeKnowledgeBaseCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 ChangeKnowledgeBaseCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeKnowledgeBaseCompartmentResponse) String() string
ContentModerationConfig The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
type ContentModerationConfig struct {
// A flag to enable or disable content moderation on input.
ShouldEnableOnInput *bool `mandatory:"false" json:"shouldEnableOnInput"`
// A flag to enable or disable content moderation on output.
ShouldEnableOnOutput *bool `mandatory:"false" json:"shouldEnableOnOutput"`
}
func (m ContentModerationConfig) String() string
func (m ContentModerationConfig) 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
CreateAgentDetails **CreateAgentDetails** The data to create an agent.
type CreateAgentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the agent in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description about the agent.
Description *string `mandatory:"false" json:"description"`
// List of OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent.
KnowledgeBaseIds []string `mandatory:"false" json:"knowledgeBaseIds"`
// Details about purpose and responsibility of the agent
WelcomeMessage *string `mandatory:"false" json:"welcomeMessage"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateAgentDetails) String() string
func (m CreateAgentDetails) 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
CreateAgentEndpointDetails **CreateAgentEndpointDetails** The data to create an endpoint.
type CreateAgentEndpointDetails struct {
// The OCID of the agent that this endpoint is associated with.
AgentId *string `mandatory:"true" json:"agentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the endpoint in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the endpoint.
Description *string `mandatory:"false" json:"description"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
// Whether to show traces in the chat result.
ShouldEnableTrace *bool `mandatory:"false" json:"shouldEnableTrace"`
// Whether to show citations in the chat result.
ShouldEnableCitation *bool `mandatory:"false" json:"shouldEnableCitation"`
// Whether or not to enable Session-based chat.
ShouldEnableSession *bool `mandatory:"false" json:"shouldEnableSession"`
SessionConfig *SessionConfig `mandatory:"false" json:"sessionConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateAgentEndpointDetails) String() string
func (m CreateAgentEndpointDetails) 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
CreateAgentEndpointRequest wrapper for the CreateAgentEndpoint operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateAgentEndpoint.go.html to see an example of how to use CreateAgentEndpointRequest.
type CreateAgentEndpointRequest struct {
// Details for the new endpoint.
CreateAgentEndpointDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAgentEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAgentEndpointRequest) String() string
func (request CreateAgentEndpointRequest) 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
CreateAgentEndpointResponse wrapper for the CreateAgentEndpoint operation
type CreateAgentEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The AgentEndpoint instance
AgentEndpoint `presentIn:"body"`
// The URL for the created endpoint. The endpoint OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// The location for the content.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateAgentEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAgentEndpointResponse) String() string
CreateAgentRequest wrapper for the CreateAgent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateAgent.go.html to see an example of how to use CreateAgentRequest.
type CreateAgentRequest struct {
// Details for the new agent.
CreateAgentDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAgentRequest) String() string
func (request CreateAgentRequest) 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
CreateAgentResponse wrapper for the CreateAgent operation
type CreateAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Agent instance
Agent `presentIn:"body"`
// URL for the created agent. The agent OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAgentResponse) String() string
CreateDataIngestionJobDetails **CreateDataIngestionJobDetails** The data to create a data ingestion job.
type CreateDataIngestionJobDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent DataSource.
DataSourceId *string `mandatory:"true" json:"dataSourceId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the data ingestion job in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// 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 user-friendly description of the data ingestion job.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDataIngestionJobDetails) String() string
func (m CreateDataIngestionJobDetails) 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
CreateDataIngestionJobRequest wrapper for the CreateDataIngestionJob operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateDataIngestionJob.go.html to see an example of how to use CreateDataIngestionJobRequest.
type CreateDataIngestionJobRequest struct {
// Details for the new data ingestion job.
CreateDataIngestionJobDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateDataIngestionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDataIngestionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDataIngestionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDataIngestionJobRequest) String() string
func (request CreateDataIngestionJobRequest) 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
CreateDataIngestionJobResponse wrapper for the CreateDataIngestionJob operation
type CreateDataIngestionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataIngestionJob instance
DataIngestionJob `presentIn:"body"`
// The URL for the created data ingestion job. The data ingestion job OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateDataIngestionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDataIngestionJobResponse) String() string
CreateDataSourceDetails **CreateDataSourceDetails** The data to create a data source.
type CreateDataSourceDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase.
KnowledgeBaseId *string `mandatory:"true" json:"knowledgeBaseId"`
DataSourceConfig DataSourceConfig `mandatory:"true" json:"dataSourceConfig"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the data source in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// 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 data source.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDataSourceDetails) String() string
func (m *CreateDataSourceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDataSourceDetails) 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
CreateDataSourceRequest wrapper for the CreateDataSource operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateDataSource.go.html to see an example of how to use CreateDataSourceRequest.
type CreateDataSourceRequest struct {
// Details for the new data source.
CreateDataSourceDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDataSourceRequest) String() string
func (request CreateDataSourceRequest) 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
CreateDataSourceResponse wrapper for the CreateDataSource operation
type CreateDataSourceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataSource instance
DataSource `presentIn:"body"`
// URL for the created data source. The data source OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDataSourceResponse) String() string
CreateKnowledgeBaseDetails **CreateKnowledgeBaseDetails** The data to create a knowledge base.
type CreateKnowledgeBaseDetails struct {
IndexConfig IndexConfig `mandatory:"true" json:"indexConfig"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the knowledge base in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// 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 user-friendly description of the knowledge base.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateKnowledgeBaseDetails) String() string
func (m *CreateKnowledgeBaseDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateKnowledgeBaseDetails) 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
CreateKnowledgeBaseRequest wrapper for the CreateKnowledgeBase operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateKnowledgeBase.go.html to see an example of how to use CreateKnowledgeBaseRequest.
type CreateKnowledgeBaseRequest struct {
// Details for the new knowledge base.
CreateKnowledgeBaseDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running 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 removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 CreateKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKnowledgeBaseRequest) String() string
func (request CreateKnowledgeBaseRequest) 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
CreateKnowledgeBaseResponse wrapper for the CreateKnowledgeBase operation
type CreateKnowledgeBaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The KnowledgeBase instance
KnowledgeBase `presentIn:"body"`
// URL for the created knowledge base. The knowledge base OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateKnowledgeBaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKnowledgeBaseResponse) String() string
DataIngestionJob **DataIngestionJob** When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent's associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type DataIngestionJob struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DataIngestionJob.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent DataSource.
DataSourceId *string `mandatory:"true" json:"dataSourceId"`
DataIngestionJobStatistics *DataIngestionJobStatistics `mandatory:"true" json:"dataIngestionJobStatistics"`
// The date and time the data ingestion job was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the data ingestion job.
LifecycleState DataIngestionJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
Description *string `mandatory:"false" json:"description"`
// The date and time the data ingestion job was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the data ingestion job in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 DataIngestionJob) String() string
func (m DataIngestionJob) 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
DataIngestionJobCollection **DataIngestionJobCollection** Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata.
type DataIngestionJobCollection struct {
// List of data ingestion jobs.
Items []DataIngestionJobSummary `mandatory:"true" json:"items"`
}
func (m DataIngestionJobCollection) String() string
func (m DataIngestionJobCollection) 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
DataIngestionJobLifecycleStateEnum Enum with underlying type: string
type DataIngestionJobLifecycleStateEnum string
Set of constants representing the allowable values for DataIngestionJobLifecycleStateEnum
const (
DataIngestionJobLifecycleStateAccepted DataIngestionJobLifecycleStateEnum = "ACCEPTED"
DataIngestionJobLifecycleStateInProgress DataIngestionJobLifecycleStateEnum = "IN_PROGRESS"
DataIngestionJobLifecycleStateWaiting DataIngestionJobLifecycleStateEnum = "WAITING"
DataIngestionJobLifecycleStateFailed DataIngestionJobLifecycleStateEnum = "FAILED"
DataIngestionJobLifecycleStateSucceeded DataIngestionJobLifecycleStateEnum = "SUCCEEDED"
DataIngestionJobLifecycleStateDeleting DataIngestionJobLifecycleStateEnum = "DELETING"
DataIngestionJobLifecycleStateDeleted DataIngestionJobLifecycleStateEnum = "DELETED"
)
func GetDataIngestionJobLifecycleStateEnumValues() []DataIngestionJobLifecycleStateEnum
GetDataIngestionJobLifecycleStateEnumValues Enumerates the set of values for DataIngestionJobLifecycleStateEnum
func GetMappingDataIngestionJobLifecycleStateEnum(val string) (DataIngestionJobLifecycleStateEnum, bool)
GetMappingDataIngestionJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DataIngestionJobStatistics **DataIngestionJobStatistics** The statistics of data ingestion job.
type DataIngestionJobStatistics struct {
// The number of files that have failed during the ingestion.
NumberOfFailedFiles *int `mandatory:"false" json:"numberOfFailedFiles"`
// The number of files that have been successfully ingested during the ingestion.
NumberOfIngestedFiles *int `mandatory:"false" json:"numberOfIngestedFiles"`
// The duration of this ingestion job.
DurationInSeconds *int `mandatory:"false" json:"durationInSeconds"`
}
func (m DataIngestionJobStatistics) String() string
func (m DataIngestionJobStatistics) 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
DataIngestionJobSummary **DataIngestionJobSummary** Summary information about a data ingestion job.
type DataIngestionJobSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent DataSource.
DataSourceId *string `mandatory:"true" json:"dataSourceId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the data ingestion job was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the data ingestion job.
LifecycleState DataIngestionJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A user-friendly description of the DataSource.
Description *string `mandatory:"false" json:"description"`
// The date and time the data ingestion job was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the data ingestion job in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 DataIngestionJobSummary) String() string
func (m DataIngestionJobSummary) 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
DataSource **DataSource** A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using the knowledge base can refer to the data. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type DataSource struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase.
KnowledgeBaseId *string `mandatory:"true" json:"knowledgeBaseId"`
DataSourceConfig DataSourceConfig `mandatory:"true" json:"dataSourceConfig"`
// The date and time the data source was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the data source.
LifecycleState DataSourceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A description of the data source.
Description *string `mandatory:"false" json:"description"`
// The date and time the data source was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the data source in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 DataSource) String() string
func (m *DataSource) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DataSource) 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
DataSourceCollection **DataSourceCollection** Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata.
type DataSourceCollection struct {
// List of data sources.
Items []DataSourceSummary `mandatory:"true" json:"items"`
}
func (m DataSourceCollection) String() string
func (m DataSourceCollection) 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
DataSourceConfig **DataSourceConfig** The details of data source.
type DataSourceConfig interface {
}
DataSourceConfigDataSourceConfigTypeEnum Enum with underlying type: string
type DataSourceConfigDataSourceConfigTypeEnum string
Set of constants representing the allowable values for DataSourceConfigDataSourceConfigTypeEnum
const (
DataSourceConfigDataSourceConfigTypeOciObjectStorage DataSourceConfigDataSourceConfigTypeEnum = "OCI_OBJECT_STORAGE"
)
func GetDataSourceConfigDataSourceConfigTypeEnumValues() []DataSourceConfigDataSourceConfigTypeEnum
GetDataSourceConfigDataSourceConfigTypeEnumValues Enumerates the set of values for DataSourceConfigDataSourceConfigTypeEnum
func GetMappingDataSourceConfigDataSourceConfigTypeEnum(val string) (DataSourceConfigDataSourceConfigTypeEnum, bool)
GetMappingDataSourceConfigDataSourceConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DataSourceLifecycleStateEnum Enum with underlying type: string
type DataSourceLifecycleStateEnum string
Set of constants representing the allowable values for DataSourceLifecycleStateEnum
const (
DataSourceLifecycleStateCreating DataSourceLifecycleStateEnum = "CREATING"
DataSourceLifecycleStateActive DataSourceLifecycleStateEnum = "ACTIVE"
DataSourceLifecycleStateInactive DataSourceLifecycleStateEnum = "INACTIVE"
DataSourceLifecycleStateUpdating DataSourceLifecycleStateEnum = "UPDATING"
DataSourceLifecycleStateDeleting DataSourceLifecycleStateEnum = "DELETING"
DataSourceLifecycleStateDeleted DataSourceLifecycleStateEnum = "DELETED"
DataSourceLifecycleStateFailed DataSourceLifecycleStateEnum = "FAILED"
)
func GetDataSourceLifecycleStateEnumValues() []DataSourceLifecycleStateEnum
GetDataSourceLifecycleStateEnumValues Enumerates the set of values for DataSourceLifecycleStateEnum
func GetMappingDataSourceLifecycleStateEnum(val string) (DataSourceLifecycleStateEnum, bool)
GetMappingDataSourceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DataSourceSummary **DataSourceSummary** Summary information about a data source.
type DataSourceSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase.
KnowledgeBaseId *string `mandatory:"true" json:"knowledgeBaseId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the data source was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the data source.
LifecycleState DataSourceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A description of the data source.
Description *string `mandatory:"false" json:"description"`
// The date and time the DataSource was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the data source in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 DataSourceSummary) String() string
func (m DataSourceSummary) 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
DatabaseConnection **DatabaseConnection** The connection type for Databases.
type DatabaseConnection interface {
}
DatabaseConnectionConnectionTypeEnum Enum with underlying type: string
type DatabaseConnectionConnectionTypeEnum string
Set of constants representing the allowable values for DatabaseConnectionConnectionTypeEnum
const (
DatabaseConnectionConnectionTypeDatabaseToolConnection DatabaseConnectionConnectionTypeEnum = "DATABASE_TOOL_CONNECTION"
)
func GetDatabaseConnectionConnectionTypeEnumValues() []DatabaseConnectionConnectionTypeEnum
GetDatabaseConnectionConnectionTypeEnumValues Enumerates the set of values for DatabaseConnectionConnectionTypeEnum
func GetMappingDatabaseConnectionConnectionTypeEnum(val string) (DatabaseConnectionConnectionTypeEnum, bool)
GetMappingDatabaseConnectionConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DatabaseFunction **DatabaseFunction** The details of Database function.
type DatabaseFunction struct {
// The name of the Database function.
Name *string `mandatory:"true" json:"name"`
}
func (m DatabaseFunction) String() string
func (m DatabaseFunction) 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
DatabaseToolConnection **DatabaseToolConnection** The details of the customer Database Tools Connection.
type DatabaseToolConnection struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
ConnectionId *string `mandatory:"true" json:"connectionId"`
}
func (m DatabaseToolConnection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DatabaseToolConnection) String() string
func (m DatabaseToolConnection) 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
DefaultIndexConfig **DefaultIndexConfig** The default index is service managed vector store on behalf of the customer.
type DefaultIndexConfig struct {
// Whether to enable Hybrid search in service managed OpenSearch.
ShouldEnableHybridSearch *bool `mandatory:"false" json:"shouldEnableHybridSearch"`
}
func (m DefaultIndexConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultIndexConfig) String() string
func (m DefaultIndexConfig) 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
DeleteAgentEndpointRequest wrapper for the DeleteAgentEndpoint operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteAgentEndpoint.go.html to see an example of how to use DeleteAgentEndpointRequest.
type DeleteAgentEndpointRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAgentEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAgentEndpointRequest) String() string
func (request DeleteAgentEndpointRequest) 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
DeleteAgentEndpointResponse wrapper for the DeleteAgentEndpoint operation
type DeleteAgentEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteAgentEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAgentEndpointResponse) String() string
DeleteAgentRequest wrapper for the DeleteAgent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteAgent.go.html to see an example of how to use DeleteAgentRequest.
type DeleteAgentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
AgentId *string `mandatory:"true" contributesTo:"path" name:"agentId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAgentRequest) String() string
func (request DeleteAgentRequest) 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
DeleteAgentResponse wrapper for the DeleteAgent operation
type DeleteAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAgentResponse) String() string
DeleteDataIngestionJobRequest wrapper for the DeleteDataIngestionJob operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteDataIngestionJob.go.html to see an example of how to use DeleteDataIngestionJobRequest.
type DeleteDataIngestionJobRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job.
DataIngestionJobId *string `mandatory:"true" contributesTo:"path" name:"dataIngestionJobId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteDataIngestionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDataIngestionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDataIngestionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDataIngestionJobRequest) String() string
func (request DeleteDataIngestionJobRequest) 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
DeleteDataIngestionJobResponse wrapper for the DeleteDataIngestionJob operation
type DeleteDataIngestionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteDataIngestionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDataIngestionJobResponse) String() string
DeleteDataSourceRequest wrapper for the DeleteDataSource operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteDataSource.go.html to see an example of how to use DeleteDataSourceRequest.
type DeleteDataSourceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
DataSourceId *string `mandatory:"true" contributesTo:"path" name:"dataSourceId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDataSourceRequest) String() string
func (request DeleteDataSourceRequest) 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
DeleteDataSourceResponse wrapper for the DeleteDataSource operation
type DeleteDataSourceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDataSourceResponse) String() string
DeleteKnowledgeBaseRequest wrapper for the DeleteKnowledgeBase operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteKnowledgeBase.go.html to see an example of how to use DeleteKnowledgeBaseRequest.
type DeleteKnowledgeBaseRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
KnowledgeBaseId *string `mandatory:"true" contributesTo:"path" name:"knowledgeBaseId"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 DeleteKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteKnowledgeBaseRequest) String() string
func (request DeleteKnowledgeBaseRequest) 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
DeleteKnowledgeBaseResponse wrapper for the DeleteKnowledgeBase operation
type DeleteKnowledgeBaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteKnowledgeBaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteKnowledgeBaseResponse) String() string
GenerativeAiAgentClient a client for GenerativeAiAgent
type GenerativeAiAgentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGenerativeAiAgentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenerativeAiAgentClient, err error)
NewGenerativeAiAgentClientWithConfigurationProvider Creates a new default GenerativeAiAgent client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGenerativeAiAgentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenerativeAiAgentClient, err error)
NewGenerativeAiAgentClientWithOboToken Creates a new default GenerativeAiAgent 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 GenerativeAiAgentClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest **CancelWorkRequest** Cancels a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client GenerativeAiAgentClient) ChangeAgentCompartment(ctx context.Context, request ChangeAgentCompartmentRequest) (response ChangeAgentCompartmentResponse, err error)
ChangeAgentCompartment **ChangeAgentCompartment** Moves an agent into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ChangeAgentCompartment.go.html to see an example of how to use ChangeAgentCompartment API. A default retry strategy applies to this operation ChangeAgentCompartment()
func (client GenerativeAiAgentClient) ChangeAgentEndpointCompartment(ctx context.Context, request ChangeAgentEndpointCompartmentRequest) (response ChangeAgentEndpointCompartmentResponse, err error)
ChangeAgentEndpointCompartment **ChangeAgentEndpointCompartment** Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ChangeAgentEndpointCompartment.go.html to see an example of how to use ChangeAgentEndpointCompartment API. A default retry strategy applies to this operation ChangeAgentEndpointCompartment()
func (client GenerativeAiAgentClient) ChangeKnowledgeBaseCompartment(ctx context.Context, request ChangeKnowledgeBaseCompartmentRequest) (response ChangeKnowledgeBaseCompartmentResponse, err error)
ChangeKnowledgeBaseCompartment **ChangeKnowledgeBaseCompartment** Moves a knowledge base into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ChangeKnowledgeBaseCompartment.go.html to see an example of how to use ChangeKnowledgeBaseCompartment API. A default retry strategy applies to this operation ChangeKnowledgeBaseCompartment()
func (client *GenerativeAiAgentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GenerativeAiAgentClient) CreateAgent(ctx context.Context, request CreateAgentRequest) (response CreateAgentResponse, err error)
CreateAgent **CreateAgent** Creates an agent.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateAgent.go.html to see an example of how to use CreateAgent API. A default retry strategy applies to this operation CreateAgent()
func (client GenerativeAiAgentClient) CreateAgentEndpoint(ctx context.Context, request CreateAgentEndpointRequest) (response CreateAgentEndpointResponse, err error)
CreateAgentEndpoint **CreateAgentEndpoint** Creates an endpoint.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateAgentEndpoint.go.html to see an example of how to use CreateAgentEndpoint API. A default retry strategy applies to this operation CreateAgentEndpoint()
func (client GenerativeAiAgentClient) CreateDataIngestionJob(ctx context.Context, request CreateDataIngestionJobRequest) (response CreateDataIngestionJobResponse, err error)
CreateDataIngestionJob **CreateDataIngestionJob** Creates a data ingestion job.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateDataIngestionJob.go.html to see an example of how to use CreateDataIngestionJob API. A default retry strategy applies to this operation CreateDataIngestionJob()
func (client GenerativeAiAgentClient) CreateDataSource(ctx context.Context, request CreateDataSourceRequest) (response CreateDataSourceResponse, err error)
CreateDataSource **CreateDataSource** Creates a data source.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateDataSource.go.html to see an example of how to use CreateDataSource API. A default retry strategy applies to this operation CreateDataSource()
func (client GenerativeAiAgentClient) CreateKnowledgeBase(ctx context.Context, request CreateKnowledgeBaseRequest) (response CreateKnowledgeBaseResponse, err error)
CreateKnowledgeBase **CreateKnowledgeBase** Creates a knowledge base.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/CreateKnowledgeBase.go.html to see an example of how to use CreateKnowledgeBase API. A default retry strategy applies to this operation CreateKnowledgeBase()
func (client GenerativeAiAgentClient) DeleteAgent(ctx context.Context, request DeleteAgentRequest) (response DeleteAgentResponse, err error)
DeleteAgent **DeleteAgent** Deletes an agent.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteAgent.go.html to see an example of how to use DeleteAgent API. A default retry strategy applies to this operation DeleteAgent()
func (client GenerativeAiAgentClient) DeleteAgentEndpoint(ctx context.Context, request DeleteAgentEndpointRequest) (response DeleteAgentEndpointResponse, err error)
DeleteAgentEndpoint **DeleteAgentEndpoint** Deletes an endpoint.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteAgentEndpoint.go.html to see an example of how to use DeleteAgentEndpoint API. A default retry strategy applies to this operation DeleteAgentEndpoint()
func (client GenerativeAiAgentClient) DeleteDataIngestionJob(ctx context.Context, request DeleteDataIngestionJobRequest) (response DeleteDataIngestionJobResponse, err error)
DeleteDataIngestionJob **DeleteDataIngestionJob** Deletes a data ingestion job.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteDataIngestionJob.go.html to see an example of how to use DeleteDataIngestionJob API. A default retry strategy applies to this operation DeleteDataIngestionJob()
func (client GenerativeAiAgentClient) DeleteDataSource(ctx context.Context, request DeleteDataSourceRequest) (response DeleteDataSourceResponse, err error)
DeleteDataSource **DeleteDataSource** Deletes a data source.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteDataSource.go.html to see an example of how to use DeleteDataSource API. A default retry strategy applies to this operation DeleteDataSource()
func (client GenerativeAiAgentClient) DeleteKnowledgeBase(ctx context.Context, request DeleteKnowledgeBaseRequest) (response DeleteKnowledgeBaseResponse, err error)
DeleteKnowledgeBase **DeleteKnowledgeBase** Deletes a knowledge base.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/DeleteKnowledgeBase.go.html to see an example of how to use DeleteKnowledgeBase API. A default retry strategy applies to this operation DeleteKnowledgeBase()
func (client GenerativeAiAgentClient) GetAgent(ctx context.Context, request GetAgentRequest) (response GetAgentResponse, err error)
GetAgent **GetAgent** Gets information about an agent.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetAgent.go.html to see an example of how to use GetAgent API. A default retry strategy applies to this operation GetAgent()
func (client GenerativeAiAgentClient) GetAgentEndpoint(ctx context.Context, request GetAgentEndpointRequest) (response GetAgentEndpointResponse, err error)
GetAgentEndpoint **GetAgentEndpoint** Gets information about an endpoint.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetAgentEndpoint.go.html to see an example of how to use GetAgentEndpoint API. A default retry strategy applies to this operation GetAgentEndpoint()
func (client GenerativeAiAgentClient) GetDataIngestionJob(ctx context.Context, request GetDataIngestionJobRequest) (response GetDataIngestionJobResponse, err error)
GetDataIngestionJob **GetDataIngestionJob** Gets information about a data ingestion job.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetDataIngestionJob.go.html to see an example of how to use GetDataIngestionJob API. A default retry strategy applies to this operation GetDataIngestionJob()
func (client GenerativeAiAgentClient) GetDataIngestionJobLogContent(ctx context.Context, request GetDataIngestionJobLogContentRequest) (response GetDataIngestionJobLogContentResponse, err error)
GetDataIngestionJobLogContent **GetDataIngestionJobLogContent** Returns the raw log file for the specified data ingestion job in text format.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetDataIngestionJobLogContent.go.html to see an example of how to use GetDataIngestionJobLogContent API. A default retry strategy applies to this operation GetDataIngestionJobLogContent()
func (client GenerativeAiAgentClient) GetDataSource(ctx context.Context, request GetDataSourceRequest) (response GetDataSourceResponse, err error)
GetDataSource **GetDataSource** Gets information about a data source.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetDataSource.go.html to see an example of how to use GetDataSource API. A default retry strategy applies to this operation GetDataSource()
func (client GenerativeAiAgentClient) GetKnowledgeBase(ctx context.Context, request GetKnowledgeBaseRequest) (response GetKnowledgeBaseResponse, err error)
GetKnowledgeBase **GetKnowledgeBase** Gets information about a knowledge base.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetKnowledgeBase.go.html to see an example of how to use GetKnowledgeBase API. A default retry strategy applies to this operation GetKnowledgeBase()
func (client GenerativeAiAgentClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest **GetWorkRequest** Gets the details of a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client GenerativeAiAgentClient) ListAgentEndpoints(ctx context.Context, request ListAgentEndpointsRequest) (response ListAgentEndpointsResponse, err error)
ListAgentEndpoints **ListAgentEndpoints** Gets a list of endpoints.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListAgentEndpoints.go.html to see an example of how to use ListAgentEndpoints API. A default retry strategy applies to this operation ListAgentEndpoints()
func (client GenerativeAiAgentClient) ListAgents(ctx context.Context, request ListAgentsRequest) (response ListAgentsResponse, err error)
ListAgents **ListAgents** Gets a list of agents.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListAgents.go.html to see an example of how to use ListAgents API. A default retry strategy applies to this operation ListAgents()
func (client GenerativeAiAgentClient) ListDataIngestionJobs(ctx context.Context, request ListDataIngestionJobsRequest) (response ListDataIngestionJobsResponse, err error)
ListDataIngestionJobs **ListDataIngestionJobs** Gets a list of data ingestion jobs.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListDataIngestionJobs.go.html to see an example of how to use ListDataIngestionJobs API. A default retry strategy applies to this operation ListDataIngestionJobs()
func (client GenerativeAiAgentClient) ListDataSources(ctx context.Context, request ListDataSourcesRequest) (response ListDataSourcesResponse, err error)
ListDataSources **ListDataSources** Gets a list of data sources.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListDataSources.go.html to see an example of how to use ListDataSources API. A default retry strategy applies to this operation ListDataSources()
func (client GenerativeAiAgentClient) ListKnowledgeBases(ctx context.Context, request ListKnowledgeBasesRequest) (response ListKnowledgeBasesResponse, err error)
ListKnowledgeBases **ListKnowledgeBases** Gets a list of knowledge bases.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListKnowledgeBases.go.html to see an example of how to use ListKnowledgeBases API. A default retry strategy applies to this operation ListKnowledgeBases()
func (client GenerativeAiAgentClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors **ListWorkRequestErrors** Lists the errors for a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client GenerativeAiAgentClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs **ListWorkRequestLogs** Lists the logs for a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client GenerativeAiAgentClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests **ListWorkRequests** Lists the work requests in a compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *GenerativeAiAgentClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GenerativeAiAgentClient) UpdateAgent(ctx context.Context, request UpdateAgentRequest) (response UpdateAgentResponse, err error)
UpdateAgent **UpdateAgent** Updates an agent.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateAgent.go.html to see an example of how to use UpdateAgent API. A default retry strategy applies to this operation UpdateAgent()
func (client GenerativeAiAgentClient) UpdateAgentEndpoint(ctx context.Context, request UpdateAgentEndpointRequest) (response UpdateAgentEndpointResponse, err error)
UpdateAgentEndpoint **UpdateAgentEndpoint** Updates an endpoint.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateAgentEndpoint.go.html to see an example of how to use UpdateAgentEndpoint API. A default retry strategy applies to this operation UpdateAgentEndpoint()
func (client GenerativeAiAgentClient) UpdateDataSource(ctx context.Context, request UpdateDataSourceRequest) (response UpdateDataSourceResponse, err error)
UpdateDataSource **UpdateDataSource** Updates a data source.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateDataSource.go.html to see an example of how to use UpdateDataSource API. A default retry strategy applies to this operation UpdateDataSource()
func (client GenerativeAiAgentClient) UpdateKnowledgeBase(ctx context.Context, request UpdateKnowledgeBaseRequest) (response UpdateKnowledgeBaseResponse, err error)
UpdateKnowledgeBase **UpdateKnowledgeBase** Updates a knowledge base.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateKnowledgeBase.go.html to see an example of how to use UpdateKnowledgeBase API. A default retry strategy applies to this operation UpdateKnowledgeBase()
GetAgentEndpointRequest wrapper for the GetAgentEndpoint operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetAgentEndpoint.go.html to see an example of how to use GetAgentEndpointRequest.
type GetAgentEndpointRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAgentEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAgentEndpointRequest) String() string
func (request GetAgentEndpointRequest) 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
GetAgentEndpointResponse wrapper for the GetAgentEndpoint operation
type GetAgentEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The AgentEndpoint instance
AgentEndpoint `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 GetAgentEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAgentEndpointResponse) String() string
GetAgentRequest wrapper for the GetAgent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetAgent.go.html to see an example of how to use GetAgentRequest.
type GetAgentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
AgentId *string `mandatory:"true" contributesTo:"path" name:"agentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAgentRequest) String() string
func (request GetAgentRequest) 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
GetAgentResponse wrapper for the GetAgent operation
type GetAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Agent instance
Agent `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 GetAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAgentResponse) String() string
GetDataIngestionJobLogContentRequest wrapper for the GetDataIngestionJobLogContent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetDataIngestionJobLogContent.go.html to see an example of how to use GetDataIngestionJobLogContentRequest.
type GetDataIngestionJobLogContentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job.
DataIngestionJobId *string `mandatory:"true" contributesTo:"path" name:"dataIngestionJobId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetDataIngestionJobLogContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDataIngestionJobLogContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDataIngestionJobLogContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDataIngestionJobLogContentRequest) String() string
func (request GetDataIngestionJobLogContentRequest) 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
GetDataIngestionJobLogContentResponse wrapper for the GetDataIngestionJobLogContent operation
type GetDataIngestionJobLogContentResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Unique identifier for the request
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetDataIngestionJobLogContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDataIngestionJobLogContentResponse) String() string
GetDataIngestionJobRequest wrapper for the GetDataIngestionJob operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetDataIngestionJob.go.html to see an example of how to use GetDataIngestionJobRequest.
type GetDataIngestionJobRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data ingestion job.
DataIngestionJobId *string `mandatory:"true" contributesTo:"path" name:"dataIngestionJobId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetDataIngestionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDataIngestionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDataIngestionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDataIngestionJobRequest) String() string
func (request GetDataIngestionJobRequest) 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
GetDataIngestionJobResponse wrapper for the GetDataIngestionJob operation
type GetDataIngestionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataIngestionJob instance
DataIngestionJob `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 GetDataIngestionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDataIngestionJobResponse) String() string
GetDataSourceRequest wrapper for the GetDataSource operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetDataSource.go.html to see an example of how to use GetDataSourceRequest.
type GetDataSourceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
DataSourceId *string `mandatory:"true" contributesTo:"path" name:"dataSourceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDataSourceRequest) String() string
func (request GetDataSourceRequest) 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
GetDataSourceResponse wrapper for the GetDataSource operation
type GetDataSourceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataSource instance
DataSource `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 GetDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDataSourceResponse) String() string
GetKnowledgeBaseRequest wrapper for the GetKnowledgeBase operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetKnowledgeBase.go.html to see an example of how to use GetKnowledgeBaseRequest.
type GetKnowledgeBaseRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
KnowledgeBaseId *string `mandatory:"true" contributesTo:"path" name:"knowledgeBaseId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKnowledgeBaseRequest) String() string
func (request GetKnowledgeBaseRequest) 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
GetKnowledgeBaseResponse wrapper for the GetKnowledgeBase operation
type GetKnowledgeBaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The KnowledgeBase instance
KnowledgeBase `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 GetKnowledgeBaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKnowledgeBaseResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) 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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
IdcsSecret **IdcsSecret** The details of IDCS configured as OpenID setting in OpenSearch.
type IdcsSecret struct {
// The URL represent authentication url of the IDCS.
IdcsUrl *string `mandatory:"true" json:"idcsUrl"`
// The IDCS Connect clientId.
ClientId *string `mandatory:"true" json:"clientId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for client secret.
VaultSecretId *string `mandatory:"true" json:"vaultSecretId"`
// Fully qualified scope url
ScopeUrl *string `mandatory:"true" json:"scopeUrl"`
}
func (m IdcsSecret) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IdcsSecret) String() string
func (m IdcsSecret) 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
Index **Index** OCI OpenSearch index details.
type Index struct {
// The index name in opensearch.
Name *string `mandatory:"true" json:"name"`
Schema *IndexSchema `mandatory:"true" json:"schema"`
}
func (m Index) String() string
func (m Index) 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
IndexConfig **IndexConfig** The index configuration of Knowledge bases.
type IndexConfig interface {
}
IndexConfigIndexConfigTypeEnum Enum with underlying type: string
type IndexConfigIndexConfigTypeEnum string
Set of constants representing the allowable values for IndexConfigIndexConfigTypeEnum
const (
IndexConfigIndexConfigTypeDefaultIndexConfig IndexConfigIndexConfigTypeEnum = "DEFAULT_INDEX_CONFIG"
IndexConfigIndexConfigTypeOciOpenSearchIndexConfig IndexConfigIndexConfigTypeEnum = "OCI_OPEN_SEARCH_INDEX_CONFIG"
IndexConfigIndexConfigTypeOciDatabaseConfig IndexConfigIndexConfigTypeEnum = "OCI_DATABASE_CONFIG"
)
func GetIndexConfigIndexConfigTypeEnumValues() []IndexConfigIndexConfigTypeEnum
GetIndexConfigIndexConfigTypeEnumValues Enumerates the set of values for IndexConfigIndexConfigTypeEnum
func GetMappingIndexConfigIndexConfigTypeEnum(val string) (IndexConfigIndexConfigTypeEnum, bool)
GetMappingIndexConfigIndexConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IndexSchema **IndexSchema** The index schema details.
type IndexSchema struct {
// Body key name.
BodyKey *string `mandatory:"true" json:"bodyKey"`
// URL key that stores the URL of a document, if available.
UrlKey *string `mandatory:"false" json:"urlKey"`
// Title key that stores the Title of a document, if available.
TitleKey *string `mandatory:"false" json:"titleKey"`
// Field within customer managed OCI OpenSearch document containing the vector embedding for queries.
EmbeddingBodyKey *string `mandatory:"false" json:"embeddingBodyKey"`
}
func (m IndexSchema) String() string
func (m IndexSchema) 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
KnowledgeBase **KnowledgeBase** A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type KnowledgeBase struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
IndexConfig IndexConfig `mandatory:"true" json:"indexConfig"`
// The date and time the knowledge base was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the knowledge base.
LifecycleState KnowledgeBaseLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A description of the knowledge base.
Description *string `mandatory:"false" json:"description"`
// The date and time the knowledge base was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the knowledge base in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 KnowledgeBase) String() string
func (m *KnowledgeBase) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m KnowledgeBase) 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
KnowledgeBaseCollection **KnowledgeBaseCollection** Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata.
type KnowledgeBaseCollection struct {
// List of knowledge bases.
Items []KnowledgeBaseSummary `mandatory:"true" json:"items"`
}
func (m KnowledgeBaseCollection) String() string
func (m KnowledgeBaseCollection) 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
KnowledgeBaseLifecycleStateEnum Enum with underlying type: string
type KnowledgeBaseLifecycleStateEnum string
Set of constants representing the allowable values for KnowledgeBaseLifecycleStateEnum
const (
KnowledgeBaseLifecycleStateCreating KnowledgeBaseLifecycleStateEnum = "CREATING"
KnowledgeBaseLifecycleStateUpdating KnowledgeBaseLifecycleStateEnum = "UPDATING"
KnowledgeBaseLifecycleStateActive KnowledgeBaseLifecycleStateEnum = "ACTIVE"
KnowledgeBaseLifecycleStateInactive KnowledgeBaseLifecycleStateEnum = "INACTIVE"
KnowledgeBaseLifecycleStateDeleting KnowledgeBaseLifecycleStateEnum = "DELETING"
KnowledgeBaseLifecycleStateDeleted KnowledgeBaseLifecycleStateEnum = "DELETED"
KnowledgeBaseLifecycleStateFailed KnowledgeBaseLifecycleStateEnum = "FAILED"
)
func GetKnowledgeBaseLifecycleStateEnumValues() []KnowledgeBaseLifecycleStateEnum
GetKnowledgeBaseLifecycleStateEnumValues Enumerates the set of values for KnowledgeBaseLifecycleStateEnum
func GetMappingKnowledgeBaseLifecycleStateEnum(val string) (KnowledgeBaseLifecycleStateEnum, bool)
GetMappingKnowledgeBaseLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KnowledgeBaseSummary **KnowledgeBaseSummary** Summary information about a knowledge base.
type KnowledgeBaseSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the knowledge base was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the knowledge base.
LifecycleState KnowledgeBaseLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// A user-friendly description of the knowledge base.
Description *string `mandatory:"false" json:"description"`
// The date and time the knowledge base was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message that describes the current state of the knowledge base in more detail. For example,
// can be used to provide actionable information for a resource in the Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 KnowledgeBaseSummary) String() string
func (m KnowledgeBaseSummary) 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
ListAgentEndpointsRequest wrapper for the ListAgentEndpoints operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListAgentEndpoints.go.html to see an example of how to use ListAgentEndpointsRequest.
type ListAgentEndpointsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
AgentId *string `mandatory:"false" contributesTo:"query" name:"agentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState AgentEndpointLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListAgentEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListAgentEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListAgentEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAgentEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAgentEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAgentEndpointsRequest) String() string
func (request ListAgentEndpointsRequest) 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
ListAgentEndpointsResponse wrapper for the ListAgentEndpoints operation
type ListAgentEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AgentEndpointCollection instances
AgentEndpointCollection `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"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAgentEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAgentEndpointsResponse) String() string
ListAgentEndpointsSortByEnum Enum with underlying type: string
type ListAgentEndpointsSortByEnum string
Set of constants representing the allowable values for ListAgentEndpointsSortByEnum
const (
ListAgentEndpointsSortByTimecreated ListAgentEndpointsSortByEnum = "timeCreated"
ListAgentEndpointsSortByDisplayname ListAgentEndpointsSortByEnum = "displayName"
)
func GetListAgentEndpointsSortByEnumValues() []ListAgentEndpointsSortByEnum
GetListAgentEndpointsSortByEnumValues Enumerates the set of values for ListAgentEndpointsSortByEnum
func GetMappingListAgentEndpointsSortByEnum(val string) (ListAgentEndpointsSortByEnum, bool)
GetMappingListAgentEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAgentEndpointsSortOrderEnum Enum with underlying type: string
type ListAgentEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListAgentEndpointsSortOrderEnum
const (
ListAgentEndpointsSortOrderAsc ListAgentEndpointsSortOrderEnum = "ASC"
ListAgentEndpointsSortOrderDesc ListAgentEndpointsSortOrderEnum = "DESC"
)
func GetListAgentEndpointsSortOrderEnumValues() []ListAgentEndpointsSortOrderEnum
GetListAgentEndpointsSortOrderEnumValues Enumerates the set of values for ListAgentEndpointsSortOrderEnum
func GetMappingListAgentEndpointsSortOrderEnum(val string) (ListAgentEndpointsSortOrderEnum, bool)
GetMappingListAgentEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAgentsRequest wrapper for the ListAgents operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListAgents.go.html to see an example of how to use ListAgentsRequest.
type ListAgentsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState AgentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListAgentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListAgentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListAgentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAgentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAgentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAgentsRequest) String() string
func (request ListAgentsRequest) 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
ListAgentsResponse wrapper for the ListAgents operation
type ListAgentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AgentCollection instances
AgentCollection `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"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAgentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAgentsResponse) String() string
ListAgentsSortByEnum Enum with underlying type: string
type ListAgentsSortByEnum string
Set of constants representing the allowable values for ListAgentsSortByEnum
const (
ListAgentsSortByTimecreated ListAgentsSortByEnum = "timeCreated"
ListAgentsSortByDisplayname ListAgentsSortByEnum = "displayName"
)
func GetListAgentsSortByEnumValues() []ListAgentsSortByEnum
GetListAgentsSortByEnumValues Enumerates the set of values for ListAgentsSortByEnum
func GetMappingListAgentsSortByEnum(val string) (ListAgentsSortByEnum, bool)
GetMappingListAgentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAgentsSortOrderEnum Enum with underlying type: string
type ListAgentsSortOrderEnum string
Set of constants representing the allowable values for ListAgentsSortOrderEnum
const (
ListAgentsSortOrderAsc ListAgentsSortOrderEnum = "ASC"
ListAgentsSortOrderDesc ListAgentsSortOrderEnum = "DESC"
)
func GetListAgentsSortOrderEnumValues() []ListAgentsSortOrderEnum
GetListAgentsSortOrderEnumValues Enumerates the set of values for ListAgentsSortOrderEnum
func GetMappingListAgentsSortOrderEnum(val string) (ListAgentsSortOrderEnum, bool)
GetMappingListAgentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataIngestionJobsRequest wrapper for the ListDataIngestionJobs operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListDataIngestionJobs.go.html to see an example of how to use ListDataIngestionJobsRequest.
type ListDataIngestionJobsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
DataSourceId *string `mandatory:"false" contributesTo:"query" name:"dataSourceId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState DataIngestionJobLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListDataIngestionJobsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListDataIngestionJobsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListDataIngestionJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDataIngestionJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDataIngestionJobsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataIngestionJobsRequest) String() string
func (request ListDataIngestionJobsRequest) 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
ListDataIngestionJobsResponse wrapper for the ListDataIngestionJobs operation
type ListDataIngestionJobsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DataIngestionJobCollection instances
DataIngestionJobCollection `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"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDataIngestionJobsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDataIngestionJobsResponse) String() string
ListDataIngestionJobsSortByEnum Enum with underlying type: string
type ListDataIngestionJobsSortByEnum string
Set of constants representing the allowable values for ListDataIngestionJobsSortByEnum
const (
ListDataIngestionJobsSortByTimecreated ListDataIngestionJobsSortByEnum = "timeCreated"
ListDataIngestionJobsSortByDisplayname ListDataIngestionJobsSortByEnum = "displayName"
)
func GetListDataIngestionJobsSortByEnumValues() []ListDataIngestionJobsSortByEnum
GetListDataIngestionJobsSortByEnumValues Enumerates the set of values for ListDataIngestionJobsSortByEnum
func GetMappingListDataIngestionJobsSortByEnum(val string) (ListDataIngestionJobsSortByEnum, bool)
GetMappingListDataIngestionJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataIngestionJobsSortOrderEnum Enum with underlying type: string
type ListDataIngestionJobsSortOrderEnum string
Set of constants representing the allowable values for ListDataIngestionJobsSortOrderEnum
const (
ListDataIngestionJobsSortOrderAsc ListDataIngestionJobsSortOrderEnum = "ASC"
ListDataIngestionJobsSortOrderDesc ListDataIngestionJobsSortOrderEnum = "DESC"
)
func GetListDataIngestionJobsSortOrderEnumValues() []ListDataIngestionJobsSortOrderEnum
GetListDataIngestionJobsSortOrderEnumValues Enumerates the set of values for ListDataIngestionJobsSortOrderEnum
func GetMappingListDataIngestionJobsSortOrderEnum(val string) (ListDataIngestionJobsSortOrderEnum, bool)
GetMappingListDataIngestionJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataSourcesRequest wrapper for the ListDataSources operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListDataSources.go.html to see an example of how to use ListDataSourcesRequest.
type ListDataSourcesRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
KnowledgeBaseId *string `mandatory:"false" contributesTo:"query" name:"knowledgeBaseId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState DataSourceLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListDataSourcesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListDataSourcesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListDataSourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDataSourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDataSourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataSourcesRequest) String() string
func (request ListDataSourcesRequest) 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
ListDataSourcesResponse wrapper for the ListDataSources operation
type ListDataSourcesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DataSourceCollection instances
DataSourceCollection `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"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDataSourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDataSourcesResponse) String() string
ListDataSourcesSortByEnum Enum with underlying type: string
type ListDataSourcesSortByEnum string
Set of constants representing the allowable values for ListDataSourcesSortByEnum
const (
ListDataSourcesSortByTimecreated ListDataSourcesSortByEnum = "timeCreated"
ListDataSourcesSortByDisplayname ListDataSourcesSortByEnum = "displayName"
)
func GetListDataSourcesSortByEnumValues() []ListDataSourcesSortByEnum
GetListDataSourcesSortByEnumValues Enumerates the set of values for ListDataSourcesSortByEnum
func GetMappingListDataSourcesSortByEnum(val string) (ListDataSourcesSortByEnum, bool)
GetMappingListDataSourcesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataSourcesSortOrderEnum Enum with underlying type: string
type ListDataSourcesSortOrderEnum string
Set of constants representing the allowable values for ListDataSourcesSortOrderEnum
const (
ListDataSourcesSortOrderAsc ListDataSourcesSortOrderEnum = "ASC"
ListDataSourcesSortOrderDesc ListDataSourcesSortOrderEnum = "DESC"
)
func GetListDataSourcesSortOrderEnumValues() []ListDataSourcesSortOrderEnum
GetListDataSourcesSortOrderEnumValues Enumerates the set of values for ListDataSourcesSortOrderEnum
func GetMappingListDataSourcesSortOrderEnum(val string) (ListDataSourcesSortOrderEnum, bool)
GetMappingListDataSourcesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListKnowledgeBasesRequest wrapper for the ListKnowledgeBases operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListKnowledgeBases.go.html to see an example of how to use ListKnowledgeBasesRequest.
type ListKnowledgeBasesRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState KnowledgeBaseLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListKnowledgeBasesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
// is descending. Default order for `displayName` is ascending.
SortBy ListKnowledgeBasesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 ListKnowledgeBasesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListKnowledgeBasesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKnowledgeBasesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKnowledgeBasesRequest) String() string
func (request ListKnowledgeBasesRequest) 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
ListKnowledgeBasesResponse wrapper for the ListKnowledgeBases operation
type ListKnowledgeBasesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of KnowledgeBaseCollection instances
KnowledgeBaseCollection `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"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListKnowledgeBasesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKnowledgeBasesResponse) String() string
ListKnowledgeBasesSortByEnum Enum with underlying type: string
type ListKnowledgeBasesSortByEnum string
Set of constants representing the allowable values for ListKnowledgeBasesSortByEnum
const (
ListKnowledgeBasesSortByTimecreated ListKnowledgeBasesSortByEnum = "timeCreated"
ListKnowledgeBasesSortByDisplayname ListKnowledgeBasesSortByEnum = "displayName"
)
func GetListKnowledgeBasesSortByEnumValues() []ListKnowledgeBasesSortByEnum
GetListKnowledgeBasesSortByEnumValues Enumerates the set of values for ListKnowledgeBasesSortByEnum
func GetMappingListKnowledgeBasesSortByEnum(val string) (ListKnowledgeBasesSortByEnum, bool)
GetMappingListKnowledgeBasesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListKnowledgeBasesSortOrderEnum Enum with underlying type: string
type ListKnowledgeBasesSortOrderEnum string
Set of constants representing the allowable values for ListKnowledgeBasesSortOrderEnum
const (
ListKnowledgeBasesSortOrderAsc ListKnowledgeBasesSortOrderEnum = "ASC"
ListKnowledgeBasesSortOrderDesc ListKnowledgeBasesSortOrderEnum = "DESC"
)
func GetListKnowledgeBasesSortOrderEnumValues() []ListKnowledgeBasesSortOrderEnum
GetListKnowledgeBasesSortOrderEnumValues Enumerates the set of values for ListKnowledgeBasesSortOrderEnum
func GetMappingListKnowledgeBasesSortOrderEnum(val string) (ListKnowledgeBasesSortOrderEnum, bool)
GetMappingListKnowledgeBasesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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 ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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 ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a
// paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ObjectStoragePrefix **ObjectStoragePrefix** The details of OCI Object Storage object.
type ObjectStoragePrefix struct {
// The namespace name of an object.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The bucket name of an object.
BucketName *string `mandatory:"true" json:"bucketName"`
// The name of the object (file) or prefix (folder).
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m ObjectStoragePrefix) String() string
func (m ObjectStoragePrefix) 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
OciDatabaseConfig **OciDatabaseConfig** The details of the customer Database Connection.
type OciDatabaseConfig struct {
DatabaseConnection DatabaseConnection `mandatory:"true" json:"databaseConnection"`
// Array of Database functions to be used.
DatabaseFunctions []DatabaseFunction `mandatory:"true" json:"databaseFunctions"`
}
func (m OciDatabaseConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciDatabaseConfig) String() string
func (m *OciDatabaseConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m OciDatabaseConfig) 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
OciObjectStorageDataSourceConfig **OciObjectStorageDataSourceConfig** The details of OCI Search with OpenSearch data source information.
type OciObjectStorageDataSourceConfig struct {
// The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
ObjectStoragePrefixes []ObjectStoragePrefix `mandatory:"true" json:"objectStoragePrefixes"`
}
func (m OciObjectStorageDataSourceConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciObjectStorageDataSourceConfig) String() string
func (m OciObjectStorageDataSourceConfig) 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
OciOpenSearchIndexConfig **OciOpenSearchIndexConfig** The details of customer managed OCI OpenSearch.
type OciOpenSearchIndexConfig struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
ClusterId *string `mandatory:"true" json:"clusterId"`
SecretDetail SecretDetail `mandatory:"true" json:"secretDetail"`
// Index configuration for open search.
Indexes []Index `mandatory:"true" json:"indexes"`
}
func (m OciOpenSearchIndexConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciOpenSearchIndexConfig) String() string
func (m *OciOpenSearchIndexConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m OciOpenSearchIndexConfig) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateAgent OperationTypeEnum = "CREATE_AGENT"
OperationTypeUpdateAgent OperationTypeEnum = "UPDATE_AGENT"
OperationTypeDeleteAgent OperationTypeEnum = "DELETE_AGENT"
OperationTypeMoveAgent OperationTypeEnum = "MOVE_AGENT"
OperationTypeCreateAgentEndpoint OperationTypeEnum = "CREATE_AGENT_ENDPOINT"
OperationTypeUpdateAgentEndpoint OperationTypeEnum = "UPDATE_AGENT_ENDPOINT"
OperationTypeDeleteAgentEndpoint OperationTypeEnum = "DELETE_AGENT_ENDPOINT"
OperationTypeMoveAgentEndpoint OperationTypeEnum = "MOVE_AGENT_ENDPOINT"
OperationTypeCreateDataSource OperationTypeEnum = "CREATE_DATA_SOURCE"
OperationTypeUpdateDataSource OperationTypeEnum = "UPDATE_DATA_SOURCE"
OperationTypeDeleteDataSource OperationTypeEnum = "DELETE_DATA_SOURCE"
OperationTypeCreateKnowledgeBase OperationTypeEnum = "CREATE_KNOWLEDGE_BASE"
OperationTypeUpdateKnowledgeBase OperationTypeEnum = "UPDATE_KNOWLEDGE_BASE"
OperationTypeDeleteKnowledgeBase OperationTypeEnum = "DELETE_KNOWLEDGE_BASE"
OperationTypeMoveKnowledgeBase OperationTypeEnum = "MOVE_KNOWLEDGE_BASE"
OperationTypeCreateDataIngestionJob OperationTypeEnum = "CREATE_DATA_INGESTION_JOB"
OperationTypeDeleteDataIngestionJob OperationTypeEnum = "DELETE_DATA_INGESTION_JOB"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
SecretDetail **SecretDetail** The details of configured security configuration on OpenSearch.
type SecretDetail interface {
}
SecretDetailTypeEnum Enum with underlying type: string
type SecretDetailTypeEnum string
Set of constants representing the allowable values for SecretDetailTypeEnum
const (
SecretDetailTypeIdcsSecret SecretDetailTypeEnum = "IDCS_SECRET"
SecretDetailTypeBasicAuthSecret SecretDetailTypeEnum = "BASIC_AUTH_SECRET"
)
func GetMappingSecretDetailTypeEnum(val string) (SecretDetailTypeEnum, bool)
GetMappingSecretDetailTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecretDetailTypeEnumValues() []SecretDetailTypeEnum
GetSecretDetailTypeEnumValues Enumerates the set of values for SecretDetailTypeEnum
SessionConfig **SessionConfig** Session Configuration on AgentEndpoint.
type SessionConfig struct {
// The session will become inactive after this timeout.
IdleTimeoutInSeconds *int `mandatory:"false" json:"idleTimeoutInSeconds"`
}
func (m SessionConfig) String() string
func (m SessionConfig) 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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateAgentDetails **UpdateAgentDetails** The data to update an agent.
type UpdateAgentDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description about the agent.
Description *string `mandatory:"false" json:"description"`
// List of OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent.
KnowledgeBaseIds []string `mandatory:"false" json:"knowledgeBaseIds"`
// Details about purpose and responsibility of the agent
WelcomeMessage *string `mandatory:"false" json:"welcomeMessage"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateAgentDetails) String() string
func (m UpdateAgentDetails) 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
UpdateAgentEndpointDetails **UpdateAgentEndpointDetails** The data to update an endpoint.
type UpdateAgentEndpointDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the AgentEndpoint.
Description *string `mandatory:"false" json:"description"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
// Whether to show traces in the chat result.
ShouldEnableTrace *bool `mandatory:"false" json:"shouldEnableTrace"`
// Whether to show citations in the chat result.
ShouldEnableCitation *bool `mandatory:"false" json:"shouldEnableCitation"`
SessionConfig *SessionConfig `mandatory:"false" json:"sessionConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateAgentEndpointDetails) String() string
func (m UpdateAgentEndpointDetails) 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
UpdateAgentEndpointRequest wrapper for the UpdateAgentEndpoint operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateAgentEndpoint.go.html to see an example of how to use UpdateAgentEndpointRequest.
type UpdateAgentEndpointRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
AgentEndpointId *string `mandatory:"true" contributesTo:"path" name:"agentEndpointId"`
// The information to be updated.
UpdateAgentEndpointDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdateAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAgentEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAgentEndpointRequest) String() string
func (request UpdateAgentEndpointRequest) 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
UpdateAgentEndpointResponse wrapper for the UpdateAgentEndpoint operation
type UpdateAgentEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateAgentEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAgentEndpointResponse) String() string
UpdateAgentRequest wrapper for the UpdateAgent operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateAgent.go.html to see an example of how to use UpdateAgentRequest.
type UpdateAgentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
AgentId *string `mandatory:"true" contributesTo:"path" name:"agentId"`
// The information to be updated.
UpdateAgentDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdateAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAgentRequest) String() string
func (request UpdateAgentRequest) 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
UpdateAgentResponse wrapper for the UpdateAgent operation
type UpdateAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAgentResponse) String() string
UpdateDataSourceDetails **UpdateDataSourceDetails** The data to update a data source.
type UpdateDataSourceDetails struct {
// 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 user-friendly description of the data source.
Description *string `mandatory:"false" json:"description"`
DataSourceConfig DataSourceConfig `mandatory:"false" json:"dataSourceConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDataSourceDetails) String() string
func (m *UpdateDataSourceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateDataSourceDetails) 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
UpdateDataSourceRequest wrapper for the UpdateDataSource operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateDataSource.go.html to see an example of how to use UpdateDataSourceRequest.
type UpdateDataSourceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
DataSourceId *string `mandatory:"true" contributesTo:"path" name:"dataSourceId"`
// The data source information to be updated.
UpdateDataSourceDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdateDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDataSourceRequest) String() string
func (request UpdateDataSourceRequest) 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
UpdateDataSourceResponse wrapper for the UpdateDataSource operation
type UpdateDataSourceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDataSourceResponse) String() string
UpdateKnowledgeBaseDetails **UpdateKnowledgeBaseDetails** The data to update a knowledge base.
type UpdateKnowledgeBaseDetails struct {
// 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 knowledge base.
Description *string `mandatory:"false" json:"description"`
IndexConfig IndexConfig `mandatory:"false" json:"indexConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateKnowledgeBaseDetails) String() string
func (m *UpdateKnowledgeBaseDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateKnowledgeBaseDetails) 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
UpdateKnowledgeBaseRequest wrapper for the UpdateKnowledgeBase operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.76.0/generativeaiagent/UpdateKnowledgeBase.go.html to see an example of how to use UpdateKnowledgeBaseRequest.
type UpdateKnowledgeBaseRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
KnowledgeBaseId *string `mandatory:"true" contributesTo:"path" name:"knowledgeBaseId"`
// The information to be updated.
UpdateKnowledgeBaseDetails `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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
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 UpdateKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateKnowledgeBaseRequest) String() string
func (request UpdateKnowledgeBaseRequest) 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
UpdateKnowledgeBaseResponse wrapper for the UpdateKnowledgeBase operation
type UpdateKnowledgeBaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateKnowledgeBaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateKnowledgeBaseResponse) String() string
WorkRequest **WorkRequest** An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequest) String() string
func (m WorkRequest) 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
WorkRequestError **WorkRequestError** An error encountered while performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) 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
WorkRequestErrorCollection **WorkRequestErrorCollection** A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLogEntry **WorkRequestLogEntry** A log message from performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection **WorkRequestLogEntryCollection** A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource **WorkRequestResource** A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary **WorkRequestSummary** Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) 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
WorkRequestSummaryCollection **WorkRequestSummaryCollection** A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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