generativeaiagent

package
v65.81.1 Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetAgentEndpointLifecycleStateEnumStringValues 

func GetAgentEndpointLifecycleStateEnumStringValues() []string

GetAgentEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for AgentEndpointLifecycleStateEnum

func GetAgentLifecycleStateEnumStringValues 

func GetAgentLifecycleStateEnumStringValues() []string

GetAgentLifecycleStateEnumStringValues Enumerates the set of values in String for AgentLifecycleStateEnum

func GetDataIngestionJobLifecycleStateEnumStringValues 

func GetDataIngestionJobLifecycleStateEnumStringValues() []string

GetDataIngestionJobLifecycleStateEnumStringValues Enumerates the set of values in String for DataIngestionJobLifecycleStateEnum

func GetDataSourceConfigDataSourceConfigTypeEnumStringValues 

func GetDataSourceConfigDataSourceConfigTypeEnumStringValues() []string

GetDataSourceConfigDataSourceConfigTypeEnumStringValues Enumerates the set of values in String for DataSourceConfigDataSourceConfigTypeEnum

func GetDataSourceLifecycleStateEnumStringValues 

func GetDataSourceLifecycleStateEnumStringValues() []string

GetDataSourceLifecycleStateEnumStringValues Enumerates the set of values in String for DataSourceLifecycleStateEnum

func GetDatabaseConnectionConnectionTypeEnumStringValues 

func GetDatabaseConnectionConnectionTypeEnumStringValues() []string

GetDatabaseConnectionConnectionTypeEnumStringValues Enumerates the set of values in String for DatabaseConnectionConnectionTypeEnum

func GetIndexConfigIndexConfigTypeEnumStringValues 

func GetIndexConfigIndexConfigTypeEnumStringValues() []string

GetIndexConfigIndexConfigTypeEnumStringValues Enumerates the set of values in String for IndexConfigIndexConfigTypeEnum

func GetKnowledgeBaseLifecycleStateEnumStringValues 

func GetKnowledgeBaseLifecycleStateEnumStringValues() []string

GetKnowledgeBaseLifecycleStateEnumStringValues Enumerates the set of values in String for KnowledgeBaseLifecycleStateEnum

func GetListAgentEndpointsSortByEnumStringValues 

func GetListAgentEndpointsSortByEnumStringValues() []string

GetListAgentEndpointsSortByEnumStringValues Enumerates the set of values in String for ListAgentEndpointsSortByEnum

func GetListAgentEndpointsSortOrderEnumStringValues 

func GetListAgentEndpointsSortOrderEnumStringValues() []string

GetListAgentEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListAgentEndpointsSortOrderEnum

func GetListAgentsSortByEnumStringValues 

func GetListAgentsSortByEnumStringValues() []string

GetListAgentsSortByEnumStringValues Enumerates the set of values in String for ListAgentsSortByEnum

func GetListAgentsSortOrderEnumStringValues 

func GetListAgentsSortOrderEnumStringValues() []string

GetListAgentsSortOrderEnumStringValues Enumerates the set of values in String for ListAgentsSortOrderEnum

func GetListDataIngestionJobsSortByEnumStringValues 

func GetListDataIngestionJobsSortByEnumStringValues() []string

GetListDataIngestionJobsSortByEnumStringValues Enumerates the set of values in String for ListDataIngestionJobsSortByEnum

func GetListDataIngestionJobsSortOrderEnumStringValues 

func GetListDataIngestionJobsSortOrderEnumStringValues() []string

GetListDataIngestionJobsSortOrderEnumStringValues Enumerates the set of values in String for ListDataIngestionJobsSortOrderEnum

func GetListDataSourcesSortByEnumStringValues 

func GetListDataSourcesSortByEnumStringValues() []string

GetListDataSourcesSortByEnumStringValues Enumerates the set of values in String for ListDataSourcesSortByEnum

func GetListDataSourcesSortOrderEnumStringValues 

func GetListDataSourcesSortOrderEnumStringValues() []string

GetListDataSourcesSortOrderEnumStringValues Enumerates the set of values in String for ListDataSourcesSortOrderEnum

func GetListKnowledgeBasesSortByEnumStringValues 

func GetListKnowledgeBasesSortByEnumStringValues() []string

GetListKnowledgeBasesSortByEnumStringValues Enumerates the set of values in String for ListKnowledgeBasesSortByEnum

func GetListKnowledgeBasesSortOrderEnumStringValues 

func GetListKnowledgeBasesSortOrderEnumStringValues() []string

GetListKnowledgeBasesSortOrderEnumStringValues Enumerates the set of values in String for ListKnowledgeBasesSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues 

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetSecretDetailTypeEnumStringValues 

func GetSecretDetailTypeEnumStringValues() []string

GetSecretDetailTypeEnumStringValues Enumerates the set of values in String for SecretDetailTypeEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues 

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type Agent 

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

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

func (Agent) String 

func (m Agent) String() string

func (Agent) ValidateEnumValue 

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

type AgentCollection 

type AgentCollection struct {

	// List of agents.
	Items []AgentSummary `mandatory:"true" json:"items"`
}

AgentCollection Results of an agent search. Contains both AgentSummary items and other information, such as metadata.

func (AgentCollection) String 

func (m AgentCollection) String() string

func (AgentCollection) ValidateEnumValue 

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

type AgentEndpoint 

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

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

func (AgentEndpoint) String 

func (m AgentEndpoint) String() string

func (AgentEndpoint) ValidateEnumValue 

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

type AgentEndpointCollection 

type AgentEndpointCollection struct {

	// List of endpoints.
	Items []AgentEndpointSummary `mandatory:"true" json:"items"`
}

AgentEndpointCollection Results of an agentEndpoint search. Contains both AgentEndpointSummary items and other information, such as metadata.

func (AgentEndpointCollection) String 

func (m AgentEndpointCollection) String() string

func (AgentEndpointCollection) ValidateEnumValue 

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

type AgentEndpointLifecycleStateEnum 

type AgentEndpointLifecycleStateEnum string

AgentEndpointLifecycleStateEnum Enum with underlying type: string 

const (
	AgentEndpointLifecycleStateCreating AgentEndpointLifecycleStateEnum = "CREATING"
	AgentEndpointLifecycleStateUpdating AgentEndpointLifecycleStateEnum = "UPDATING"
	AgentEndpointLifecycleStateActive   AgentEndpointLifecycleStateEnum = "ACTIVE"
	AgentEndpointLifecycleStateDeleting AgentEndpointLifecycleStateEnum = "DELETING"
	AgentEndpointLifecycleStateDeleted  AgentEndpointLifecycleStateEnum = "DELETED"
	AgentEndpointLifecycleStateFailed   AgentEndpointLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for AgentEndpointLifecycleStateEnum

func GetAgentEndpointLifecycleStateEnumValues 

func GetAgentEndpointLifecycleStateEnumValues() []AgentEndpointLifecycleStateEnum

GetAgentEndpointLifecycleStateEnumValues Enumerates the set of values for AgentEndpointLifecycleStateEnum

func GetMappingAgentEndpointLifecycleStateEnum 

func GetMappingAgentEndpointLifecycleStateEnum(val string) (AgentEndpointLifecycleStateEnum, bool)

GetMappingAgentEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type AgentEndpointSummary 

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

AgentEndpointSummary Summary information about an endpoint.

func (AgentEndpointSummary) String 

func (m AgentEndpointSummary) String() string

func (AgentEndpointSummary) ValidateEnumValue 

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

type AgentLifecycleStateEnum 

type AgentLifecycleStateEnum string

AgentLifecycleStateEnum Enum with underlying type: string 

const (
	AgentLifecycleStateCreating AgentLifecycleStateEnum = "CREATING"
	AgentLifecycleStateUpdating AgentLifecycleStateEnum = "UPDATING"
	AgentLifecycleStateActive   AgentLifecycleStateEnum = "ACTIVE"
	AgentLifecycleStateDeleting AgentLifecycleStateEnum = "DELETING"
	AgentLifecycleStateDeleted  AgentLifecycleStateEnum = "DELETED"
	AgentLifecycleStateFailed   AgentLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for AgentLifecycleStateEnum

func GetAgentLifecycleStateEnumValues 

func GetAgentLifecycleStateEnumValues() []AgentLifecycleStateEnum

GetAgentLifecycleStateEnumValues Enumerates the set of values for AgentLifecycleStateEnum

func GetMappingAgentLifecycleStateEnum 

func GetMappingAgentLifecycleStateEnum(val string) (AgentLifecycleStateEnum, bool)

GetMappingAgentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type AgentSummary 

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

AgentSummary Summary information about an agent.

func (AgentSummary) String 

func (m AgentSummary) String() string

func (AgentSummary) ValidateEnumValue 

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

type BasicAuthSecret 

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

BasicAuthSecret The details of Basic authentication configured as in OpenSearch.

func (BasicAuthSecret) MarshalJSON 

func (m BasicAuthSecret) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BasicAuthSecret) String 

func (m BasicAuthSecret) String() string

func (BasicAuthSecret) ValidateEnumValue 

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

type 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
}

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.

func (CancelWorkRequestRequest) BinaryRequestBody 

func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest 

func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy 

func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelWorkRequestRequest) String 

func (request CancelWorkRequestRequest) String() string

func (CancelWorkRequestRequest) ValidateEnumValue 

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

type CancelWorkRequestResponse 

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse 

func (response CancelWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String 

func (response CancelWorkRequestResponse) String() string

type ChangeAgentCompartmentDetails 

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

ChangeAgentCompartmentDetails The configuration details for the move operation.

func (ChangeAgentCompartmentDetails) String 

func (m ChangeAgentCompartmentDetails) String() string

func (ChangeAgentCompartmentDetails) ValidateEnumValue 

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

type 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
}

ChangeAgentCompartmentRequest wrapper for the ChangeAgentCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ChangeAgentCompartment.go.html to see an example of how to use ChangeAgentCompartmentRequest.

func (ChangeAgentCompartmentRequest) BinaryRequestBody 

func (request ChangeAgentCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeAgentCompartmentRequest) HTTPRequest 

func (request ChangeAgentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeAgentCompartmentRequest) RetryPolicy 

func (request ChangeAgentCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeAgentCompartmentRequest) String 

func (request ChangeAgentCompartmentRequest) String() string

func (ChangeAgentCompartmentRequest) ValidateEnumValue 

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

type ChangeAgentCompartmentResponse 

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

ChangeAgentCompartmentResponse wrapper for the ChangeAgentCompartment operation

func (ChangeAgentCompartmentResponse) HTTPResponse 

func (response ChangeAgentCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeAgentCompartmentResponse) String 

func (response ChangeAgentCompartmentResponse) String() string

type ChangeAgentEndpointCompartmentDetails 

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

ChangeAgentEndpointCompartmentDetails The configuration details for the move operation.

func (ChangeAgentEndpointCompartmentDetails) String 

func (m ChangeAgentEndpointCompartmentDetails) String() string

func (ChangeAgentEndpointCompartmentDetails) ValidateEnumValue 

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

type 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
}

ChangeAgentEndpointCompartmentRequest wrapper for the ChangeAgentEndpointCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ChangeAgentEndpointCompartment.go.html to see an example of how to use ChangeAgentEndpointCompartmentRequest.

func (ChangeAgentEndpointCompartmentRequest) BinaryRequestBody 

func (request ChangeAgentEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeAgentEndpointCompartmentRequest) HTTPRequest 

func (request ChangeAgentEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeAgentEndpointCompartmentRequest) RetryPolicy 

func (request ChangeAgentEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeAgentEndpointCompartmentRequest) String 

func (request ChangeAgentEndpointCompartmentRequest) String() string

func (ChangeAgentEndpointCompartmentRequest) ValidateEnumValue 

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

type ChangeAgentEndpointCompartmentResponse 

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

ChangeAgentEndpointCompartmentResponse wrapper for the ChangeAgentEndpointCompartment operation

func (ChangeAgentEndpointCompartmentResponse) HTTPResponse 

func (response ChangeAgentEndpointCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeAgentEndpointCompartmentResponse) String 

func (response ChangeAgentEndpointCompartmentResponse) String() string

type ChangeKnowledgeBaseCompartmentDetails 

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

ChangeKnowledgeBaseCompartmentDetails The configuration details for the move operation.

func (ChangeKnowledgeBaseCompartmentDetails) String 

func (m ChangeKnowledgeBaseCompartmentDetails) String() string

func (ChangeKnowledgeBaseCompartmentDetails) ValidateEnumValue 

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

type 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
}

ChangeKnowledgeBaseCompartmentRequest wrapper for the ChangeKnowledgeBaseCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ChangeKnowledgeBaseCompartment.go.html to see an example of how to use ChangeKnowledgeBaseCompartmentRequest.

func (ChangeKnowledgeBaseCompartmentRequest) BinaryRequestBody 

func (request ChangeKnowledgeBaseCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeKnowledgeBaseCompartmentRequest) HTTPRequest 

func (request ChangeKnowledgeBaseCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeKnowledgeBaseCompartmentRequest) RetryPolicy 

func (request ChangeKnowledgeBaseCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeKnowledgeBaseCompartmentRequest) String 

func (request ChangeKnowledgeBaseCompartmentRequest) String() string

func (ChangeKnowledgeBaseCompartmentRequest) ValidateEnumValue 

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

type ChangeKnowledgeBaseCompartmentResponse 

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

ChangeKnowledgeBaseCompartmentResponse wrapper for the ChangeKnowledgeBaseCompartment operation

func (ChangeKnowledgeBaseCompartmentResponse) HTTPResponse 

func (response ChangeKnowledgeBaseCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeKnowledgeBaseCompartmentResponse) String 

func (response ChangeKnowledgeBaseCompartmentResponse) String() string

type ContentModerationConfig 

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

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.

func (ContentModerationConfig) String 

func (m ContentModerationConfig) String() string

func (ContentModerationConfig) ValidateEnumValue 

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

type CreateAgentDetails 

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

CreateAgentDetails The data to create an agent.

func (CreateAgentDetails) String 

func (m CreateAgentDetails) String() string

func (CreateAgentDetails) ValidateEnumValue 

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

type CreateAgentEndpointDetails 

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

CreateAgentEndpointDetails The data to create an endpoint.

func (CreateAgentEndpointDetails) String 

func (m CreateAgentEndpointDetails) String() string

func (CreateAgentEndpointDetails) ValidateEnumValue 

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

type 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
}

CreateAgentEndpointRequest wrapper for the CreateAgentEndpoint operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateAgentEndpoint.go.html to see an example of how to use CreateAgentEndpointRequest.

func (CreateAgentEndpointRequest) BinaryRequestBody 

func (request CreateAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAgentEndpointRequest) HTTPRequest 

func (request CreateAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAgentEndpointRequest) RetryPolicy 

func (request CreateAgentEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAgentEndpointRequest) String 

func (request CreateAgentEndpointRequest) String() string

func (CreateAgentEndpointRequest) ValidateEnumValue 

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

type CreateAgentEndpointResponse 

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

CreateAgentEndpointResponse wrapper for the CreateAgentEndpoint operation

func (CreateAgentEndpointResponse) HTTPResponse 

func (response CreateAgentEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAgentEndpointResponse) String 

func (response CreateAgentEndpointResponse) String() string

type 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
}

CreateAgentRequest wrapper for the CreateAgent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateAgent.go.html to see an example of how to use CreateAgentRequest.

func (CreateAgentRequest) BinaryRequestBody 

func (request CreateAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAgentRequest) HTTPRequest 

func (request CreateAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAgentRequest) RetryPolicy 

func (request CreateAgentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAgentRequest) String 

func (request CreateAgentRequest) String() string

func (CreateAgentRequest) ValidateEnumValue 

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

type CreateAgentResponse 

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

CreateAgentResponse wrapper for the CreateAgent operation

func (CreateAgentResponse) HTTPResponse 

func (response CreateAgentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAgentResponse) String 

func (response CreateAgentResponse) String() string

type CreateDataIngestionJobDetails 

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

CreateDataIngestionJobDetails The data to create a data ingestion job.

func (CreateDataIngestionJobDetails) String 

func (m CreateDataIngestionJobDetails) String() string

func (CreateDataIngestionJobDetails) ValidateEnumValue 

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

type 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
}

CreateDataIngestionJobRequest wrapper for the CreateDataIngestionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateDataIngestionJob.go.html to see an example of how to use CreateDataIngestionJobRequest.

func (CreateDataIngestionJobRequest) BinaryRequestBody 

func (request CreateDataIngestionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDataIngestionJobRequest) HTTPRequest 

func (request CreateDataIngestionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDataIngestionJobRequest) RetryPolicy 

func (request CreateDataIngestionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDataIngestionJobRequest) String 

func (request CreateDataIngestionJobRequest) String() string

func (CreateDataIngestionJobRequest) ValidateEnumValue 

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

type CreateDataIngestionJobResponse 

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

CreateDataIngestionJobResponse wrapper for the CreateDataIngestionJob operation

func (CreateDataIngestionJobResponse) HTTPResponse 

func (response CreateDataIngestionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDataIngestionJobResponse) String 

func (response CreateDataIngestionJobResponse) String() string

type CreateDataSourceDetails 

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

CreateDataSourceDetails The data to create a data source.

func (CreateDataSourceDetails) String 

func (m CreateDataSourceDetails) String() string

func (*CreateDataSourceDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateDataSourceDetails) ValidateEnumValue 

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

type 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
}

CreateDataSourceRequest wrapper for the CreateDataSource operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateDataSource.go.html to see an example of how to use CreateDataSourceRequest.

func (CreateDataSourceRequest) BinaryRequestBody 

func (request CreateDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDataSourceRequest) HTTPRequest 

func (request CreateDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDataSourceRequest) RetryPolicy 

func (request CreateDataSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDataSourceRequest) String 

func (request CreateDataSourceRequest) String() string

func (CreateDataSourceRequest) ValidateEnumValue 

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

type CreateDataSourceResponse 

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

CreateDataSourceResponse wrapper for the CreateDataSource operation

func (CreateDataSourceResponse) HTTPResponse 

func (response CreateDataSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDataSourceResponse) String 

func (response CreateDataSourceResponse) String() string

type CreateKnowledgeBaseDetails 

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

CreateKnowledgeBaseDetails The data to create a knowledge base.

func (CreateKnowledgeBaseDetails) String 

func (m CreateKnowledgeBaseDetails) String() string

func (*CreateKnowledgeBaseDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateKnowledgeBaseDetails) ValidateEnumValue 

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

type 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
}

CreateKnowledgeBaseRequest wrapper for the CreateKnowledgeBase operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateKnowledgeBase.go.html to see an example of how to use CreateKnowledgeBaseRequest.

func (CreateKnowledgeBaseRequest) BinaryRequestBody 

func (request CreateKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateKnowledgeBaseRequest) HTTPRequest 

func (request CreateKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateKnowledgeBaseRequest) RetryPolicy 

func (request CreateKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateKnowledgeBaseRequest) String 

func (request CreateKnowledgeBaseRequest) String() string

func (CreateKnowledgeBaseRequest) ValidateEnumValue 

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

type CreateKnowledgeBaseResponse 

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

CreateKnowledgeBaseResponse wrapper for the CreateKnowledgeBase operation

func (CreateKnowledgeBaseResponse) HTTPResponse 

func (response CreateKnowledgeBaseResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateKnowledgeBaseResponse) String 

func (response CreateKnowledgeBaseResponse) String() string

type DataIngestionJob 

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 OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent KnowledgeBase.
	KnowledgeBaseId *string `mandatory:"false" json:"knowledgeBaseId"`

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

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

func (DataIngestionJob) String 

func (m DataIngestionJob) String() string

func (DataIngestionJob) ValidateEnumValue 

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

type DataIngestionJobCollection 

type DataIngestionJobCollection struct {

	// List of data ingestion jobs.
	Items []DataIngestionJobSummary `mandatory:"true" json:"items"`
}

DataIngestionJobCollection Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata.

func (DataIngestionJobCollection) String 

func (m DataIngestionJobCollection) String() string

func (DataIngestionJobCollection) ValidateEnumValue 

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

type DataIngestionJobLifecycleStateEnum 

type DataIngestionJobLifecycleStateEnum string

DataIngestionJobLifecycleStateEnum Enum with underlying type: string 

const (
	DataIngestionJobLifecycleStateAccepted   DataIngestionJobLifecycleStateEnum = "ACCEPTED"
	DataIngestionJobLifecycleStateInProgress DataIngestionJobLifecycleStateEnum = "IN_PROGRESS"
	DataIngestionJobLifecycleStateWaiting    DataIngestionJobLifecycleStateEnum = "WAITING"
	DataIngestionJobLifecycleStateFailed     DataIngestionJobLifecycleStateEnum = "FAILED"
	DataIngestionJobLifecycleStateSucceeded  DataIngestionJobLifecycleStateEnum = "SUCCEEDED"
	DataIngestionJobLifecycleStateDeleting   DataIngestionJobLifecycleStateEnum = "DELETING"
	DataIngestionJobLifecycleStateDeleted    DataIngestionJobLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for DataIngestionJobLifecycleStateEnum

func GetDataIngestionJobLifecycleStateEnumValues 

func GetDataIngestionJobLifecycleStateEnumValues() []DataIngestionJobLifecycleStateEnum

GetDataIngestionJobLifecycleStateEnumValues Enumerates the set of values for DataIngestionJobLifecycleStateEnum

func GetMappingDataIngestionJobLifecycleStateEnum 

func GetMappingDataIngestionJobLifecycleStateEnum(val string) (DataIngestionJobLifecycleStateEnum, bool)

GetMappingDataIngestionJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DataIngestionJobStatistics 

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

DataIngestionJobStatistics The statistics of data ingestion job.

func (DataIngestionJobStatistics) String 

func (m DataIngestionJobStatistics) String() string

func (DataIngestionJobStatistics) ValidateEnumValue 

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

type DataIngestionJobSummary 

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

DataIngestionJobSummary Summary information about a data ingestion job.

func (DataIngestionJobSummary) String 

func (m DataIngestionJobSummary) String() string

func (DataIngestionJobSummary) ValidateEnumValue 

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

type DataSource 

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

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

func (DataSource) String 

func (m DataSource) String() string

func (*DataSource) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (DataSource) ValidateEnumValue 

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

type DataSourceCollection 

type DataSourceCollection struct {

	// List of data sources.
	Items []DataSourceSummary `mandatory:"true" json:"items"`
}

DataSourceCollection Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata.

func (DataSourceCollection) String 

func (m DataSourceCollection) String() string

func (DataSourceCollection) ValidateEnumValue 

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

type DataSourceConfig 

type DataSourceConfig interface {

	// Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion.
	GetShouldEnableMultiModality() *bool
}

DataSourceConfig The details of data source.

type DataSourceConfigDataSourceConfigTypeEnum 

type DataSourceConfigDataSourceConfigTypeEnum string

DataSourceConfigDataSourceConfigTypeEnum Enum with underlying type: string 

const (
	DataSourceConfigDataSourceConfigTypeOciObjectStorage DataSourceConfigDataSourceConfigTypeEnum = "OCI_OBJECT_STORAGE"
)

Set of constants representing the allowable values for DataSourceConfigDataSourceConfigTypeEnum

func GetDataSourceConfigDataSourceConfigTypeEnumValues 

func GetDataSourceConfigDataSourceConfigTypeEnumValues() []DataSourceConfigDataSourceConfigTypeEnum

GetDataSourceConfigDataSourceConfigTypeEnumValues Enumerates the set of values for DataSourceConfigDataSourceConfigTypeEnum

func GetMappingDataSourceConfigDataSourceConfigTypeEnum 

func GetMappingDataSourceConfigDataSourceConfigTypeEnum(val string) (DataSourceConfigDataSourceConfigTypeEnum, bool)

GetMappingDataSourceConfigDataSourceConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DataSourceLifecycleStateEnum 

type DataSourceLifecycleStateEnum string

DataSourceLifecycleStateEnum Enum with underlying type: string 

const (
	DataSourceLifecycleStateCreating DataSourceLifecycleStateEnum = "CREATING"
	DataSourceLifecycleStateActive   DataSourceLifecycleStateEnum = "ACTIVE"
	DataSourceLifecycleStateInactive DataSourceLifecycleStateEnum = "INACTIVE"
	DataSourceLifecycleStateUpdating DataSourceLifecycleStateEnum = "UPDATING"
	DataSourceLifecycleStateDeleting DataSourceLifecycleStateEnum = "DELETING"
	DataSourceLifecycleStateDeleted  DataSourceLifecycleStateEnum = "DELETED"
	DataSourceLifecycleStateFailed   DataSourceLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DataSourceLifecycleStateEnum

func GetDataSourceLifecycleStateEnumValues 

func GetDataSourceLifecycleStateEnumValues() []DataSourceLifecycleStateEnum

GetDataSourceLifecycleStateEnumValues Enumerates the set of values for DataSourceLifecycleStateEnum

func GetMappingDataSourceLifecycleStateEnum 

func GetMappingDataSourceLifecycleStateEnum(val string) (DataSourceLifecycleStateEnum, bool)

GetMappingDataSourceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DataSourceSummary 

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

DataSourceSummary Summary information about a data source.

func (DataSourceSummary) String 

func (m DataSourceSummary) String() string

func (DataSourceSummary) ValidateEnumValue 

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

type DatabaseConnection 

type DatabaseConnection interface {
}

DatabaseConnection The connection type for Databases.

type DatabaseConnectionConnectionTypeEnum 

type DatabaseConnectionConnectionTypeEnum string

DatabaseConnectionConnectionTypeEnum Enum with underlying type: string 

const (
	DatabaseConnectionConnectionTypeDatabaseToolConnection DatabaseConnectionConnectionTypeEnum = "DATABASE_TOOL_CONNECTION"
)

Set of constants representing the allowable values for DatabaseConnectionConnectionTypeEnum

func GetDatabaseConnectionConnectionTypeEnumValues 

func GetDatabaseConnectionConnectionTypeEnumValues() []DatabaseConnectionConnectionTypeEnum

GetDatabaseConnectionConnectionTypeEnumValues Enumerates the set of values for DatabaseConnectionConnectionTypeEnum

func GetMappingDatabaseConnectionConnectionTypeEnum 

func GetMappingDatabaseConnectionConnectionTypeEnum(val string) (DatabaseConnectionConnectionTypeEnum, bool)

GetMappingDatabaseConnectionConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DatabaseFunction 

type DatabaseFunction struct {

	// The name of the Database function.
	Name *string `mandatory:"true" json:"name"`
}

DatabaseFunction The details of Database function.

func (DatabaseFunction) String 

func (m DatabaseFunction) String() string

func (DatabaseFunction) ValidateEnumValue 

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

type DatabaseToolConnection 

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

DatabaseToolConnection The details of the customer Database Tools Connection.

func (DatabaseToolConnection) MarshalJSON 

func (m DatabaseToolConnection) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DatabaseToolConnection) String 

func (m DatabaseToolConnection) String() string

func (DatabaseToolConnection) ValidateEnumValue 

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

type DefaultIndexConfig 

type DefaultIndexConfig struct {

	// Whether to enable Hybrid search in service managed OpenSearch.
	ShouldEnableHybridSearch *bool `mandatory:"false" json:"shouldEnableHybridSearch"`
}

DefaultIndexConfig The default index is service managed vector store on behalf of the customer.

func (DefaultIndexConfig) MarshalJSON 

func (m DefaultIndexConfig) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DefaultIndexConfig) String 

func (m DefaultIndexConfig) String() string

func (DefaultIndexConfig) ValidateEnumValue 

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

type 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
}

DeleteAgentEndpointRequest wrapper for the DeleteAgentEndpoint operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteAgentEndpoint.go.html to see an example of how to use DeleteAgentEndpointRequest.

func (DeleteAgentEndpointRequest) BinaryRequestBody 

func (request DeleteAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAgentEndpointRequest) HTTPRequest 

func (request DeleteAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAgentEndpointRequest) RetryPolicy 

func (request DeleteAgentEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAgentEndpointRequest) String 

func (request DeleteAgentEndpointRequest) String() string

func (DeleteAgentEndpointRequest) ValidateEnumValue 

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

type DeleteAgentEndpointResponse 

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

DeleteAgentEndpointResponse wrapper for the DeleteAgentEndpoint operation

func (DeleteAgentEndpointResponse) HTTPResponse 

func (response DeleteAgentEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAgentEndpointResponse) String 

func (response DeleteAgentEndpointResponse) String() string

type 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
}

DeleteAgentRequest wrapper for the DeleteAgent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteAgent.go.html to see an example of how to use DeleteAgentRequest.

func (DeleteAgentRequest) BinaryRequestBody 

func (request DeleteAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAgentRequest) HTTPRequest 

func (request DeleteAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAgentRequest) RetryPolicy 

func (request DeleteAgentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAgentRequest) String 

func (request DeleteAgentRequest) String() string

func (DeleteAgentRequest) ValidateEnumValue 

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

type DeleteAgentResponse 

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

DeleteAgentResponse wrapper for the DeleteAgent operation

func (DeleteAgentResponse) HTTPResponse 

func (response DeleteAgentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAgentResponse) String 

func (response DeleteAgentResponse) String() string

type 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
}

DeleteDataIngestionJobRequest wrapper for the DeleteDataIngestionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteDataIngestionJob.go.html to see an example of how to use DeleteDataIngestionJobRequest.

func (DeleteDataIngestionJobRequest) BinaryRequestBody 

func (request DeleteDataIngestionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDataIngestionJobRequest) HTTPRequest 

func (request DeleteDataIngestionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDataIngestionJobRequest) RetryPolicy 

func (request DeleteDataIngestionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDataIngestionJobRequest) String 

func (request DeleteDataIngestionJobRequest) String() string

func (DeleteDataIngestionJobRequest) ValidateEnumValue 

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

type DeleteDataIngestionJobResponse 

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

DeleteDataIngestionJobResponse wrapper for the DeleteDataIngestionJob operation

func (DeleteDataIngestionJobResponse) HTTPResponse 

func (response DeleteDataIngestionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDataIngestionJobResponse) String 

func (response DeleteDataIngestionJobResponse) String() string

type 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
}

DeleteDataSourceRequest wrapper for the DeleteDataSource operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteDataSource.go.html to see an example of how to use DeleteDataSourceRequest.

func (DeleteDataSourceRequest) BinaryRequestBody 

func (request DeleteDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDataSourceRequest) HTTPRequest 

func (request DeleteDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDataSourceRequest) RetryPolicy 

func (request DeleteDataSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDataSourceRequest) String 

func (request DeleteDataSourceRequest) String() string

func (DeleteDataSourceRequest) ValidateEnumValue 

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

type DeleteDataSourceResponse 

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

DeleteDataSourceResponse wrapper for the DeleteDataSource operation

func (DeleteDataSourceResponse) HTTPResponse 

func (response DeleteDataSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDataSourceResponse) String 

func (response DeleteDataSourceResponse) String() string

type 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
}

DeleteKnowledgeBaseRequest wrapper for the DeleteKnowledgeBase operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteKnowledgeBase.go.html to see an example of how to use DeleteKnowledgeBaseRequest.

func (DeleteKnowledgeBaseRequest) BinaryRequestBody 

func (request DeleteKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteKnowledgeBaseRequest) HTTPRequest 

func (request DeleteKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteKnowledgeBaseRequest) RetryPolicy 

func (request DeleteKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteKnowledgeBaseRequest) String 

func (request DeleteKnowledgeBaseRequest) String() string

func (DeleteKnowledgeBaseRequest) ValidateEnumValue 

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

type DeleteKnowledgeBaseResponse 

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

DeleteKnowledgeBaseResponse wrapper for the DeleteKnowledgeBase operation

func (DeleteKnowledgeBaseResponse) HTTPResponse 

func (response DeleteKnowledgeBaseResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteKnowledgeBaseResponse) String 

func (response DeleteKnowledgeBaseResponse) String() string

type GenerativeAiAgentClient 

type GenerativeAiAgentClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

GenerativeAiAgentClient a client for GenerativeAiAgent

func NewGenerativeAiAgentClientWithConfigurationProvider 

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 

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 (GenerativeAiAgentClient) CancelWorkRequest 

func (client GenerativeAiAgentClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()

func (GenerativeAiAgentClient) ChangeAgentCompartment 

func (client GenerativeAiAgentClient) ChangeAgentCompartment(ctx context.Context, request ChangeAgentCompartmentRequest) (response ChangeAgentCompartmentResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ChangeAgentCompartment.go.html to see an example of how to use ChangeAgentCompartment API. A default retry strategy applies to this operation ChangeAgentCompartment()

func (GenerativeAiAgentClient) ChangeAgentEndpointCompartment 

func (client GenerativeAiAgentClient) ChangeAgentEndpointCompartment(ctx context.Context, request ChangeAgentEndpointCompartmentRequest) (response ChangeAgentEndpointCompartmentResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ChangeAgentEndpointCompartment.go.html to see an example of how to use ChangeAgentEndpointCompartment API. A default retry strategy applies to this operation ChangeAgentEndpointCompartment()

func (GenerativeAiAgentClient) ChangeKnowledgeBaseCompartment 

func (client GenerativeAiAgentClient) ChangeKnowledgeBaseCompartment(ctx context.Context, request ChangeKnowledgeBaseCompartmentRequest) (response ChangeKnowledgeBaseCompartmentResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ChangeKnowledgeBaseCompartment.go.html to see an example of how to use ChangeKnowledgeBaseCompartment API. A default retry strategy applies to this operation ChangeKnowledgeBaseCompartment()

func (*GenerativeAiAgentClient) ConfigurationProvider 

func (client *GenerativeAiAgentClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (GenerativeAiAgentClient) CreateAgent 

func (client GenerativeAiAgentClient) CreateAgent(ctx context.Context, request CreateAgentRequest) (response CreateAgentResponse, err error)

CreateAgent Creates an agent.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateAgent.go.html to see an example of how to use CreateAgent API. A default retry strategy applies to this operation CreateAgent()

func (GenerativeAiAgentClient) CreateAgentEndpoint 

func (client GenerativeAiAgentClient) CreateAgentEndpoint(ctx context.Context, request CreateAgentEndpointRequest) (response CreateAgentEndpointResponse, err error)

CreateAgentEndpoint Creates an endpoint.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateAgentEndpoint.go.html to see an example of how to use CreateAgentEndpoint API. A default retry strategy applies to this operation CreateAgentEndpoint()

func (GenerativeAiAgentClient) CreateDataIngestionJob 

func (client GenerativeAiAgentClient) CreateDataIngestionJob(ctx context.Context, request CreateDataIngestionJobRequest) (response CreateDataIngestionJobResponse, err error)

CreateDataIngestionJob Creates a data ingestion job.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateDataIngestionJob.go.html to see an example of how to use CreateDataIngestionJob API. A default retry strategy applies to this operation CreateDataIngestionJob()

func (GenerativeAiAgentClient) CreateDataSource 

func (client GenerativeAiAgentClient) CreateDataSource(ctx context.Context, request CreateDataSourceRequest) (response CreateDataSourceResponse, err error)

CreateDataSource Creates a data source.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateDataSource.go.html to see an example of how to use CreateDataSource API. A default retry strategy applies to this operation CreateDataSource()

func (GenerativeAiAgentClient) CreateKnowledgeBase 

func (client GenerativeAiAgentClient) CreateKnowledgeBase(ctx context.Context, request CreateKnowledgeBaseRequest) (response CreateKnowledgeBaseResponse, err error)

CreateKnowledgeBase Creates a knowledge base.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/CreateKnowledgeBase.go.html to see an example of how to use CreateKnowledgeBase API. A default retry strategy applies to this operation CreateKnowledgeBase()

func (GenerativeAiAgentClient) DeleteAgent 

func (client GenerativeAiAgentClient) DeleteAgent(ctx context.Context, request DeleteAgentRequest) (response DeleteAgentResponse, err error)

DeleteAgent Deletes an agent.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteAgent.go.html to see an example of how to use DeleteAgent API. A default retry strategy applies to this operation DeleteAgent()

func (GenerativeAiAgentClient) DeleteAgentEndpoint 

func (client GenerativeAiAgentClient) DeleteAgentEndpoint(ctx context.Context, request DeleteAgentEndpointRequest) (response DeleteAgentEndpointResponse, err error)

DeleteAgentEndpoint Deletes an endpoint.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteAgentEndpoint.go.html to see an example of how to use DeleteAgentEndpoint API. A default retry strategy applies to this operation DeleteAgentEndpoint()

func (GenerativeAiAgentClient) DeleteDataIngestionJob 

func (client GenerativeAiAgentClient) DeleteDataIngestionJob(ctx context.Context, request DeleteDataIngestionJobRequest) (response DeleteDataIngestionJobResponse, err error)

DeleteDataIngestionJob Deletes a data ingestion job.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteDataIngestionJob.go.html to see an example of how to use DeleteDataIngestionJob API. A default retry strategy applies to this operation DeleteDataIngestionJob()

func (GenerativeAiAgentClient) DeleteDataSource 

func (client GenerativeAiAgentClient) DeleteDataSource(ctx context.Context, request DeleteDataSourceRequest) (response DeleteDataSourceResponse, err error)

DeleteDataSource Deletes a data source.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteDataSource.go.html to see an example of how to use DeleteDataSource API. A default retry strategy applies to this operation DeleteDataSource()

func (GenerativeAiAgentClient) DeleteKnowledgeBase 

func (client GenerativeAiAgentClient) DeleteKnowledgeBase(ctx context.Context, request DeleteKnowledgeBaseRequest) (response DeleteKnowledgeBaseResponse, err error)

DeleteKnowledgeBase Deletes a knowledge base.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/DeleteKnowledgeBase.go.html to see an example of how to use DeleteKnowledgeBase API. A default retry strategy applies to this operation DeleteKnowledgeBase()

func (GenerativeAiAgentClient) GetAgent 

func (client GenerativeAiAgentClient) GetAgent(ctx context.Context, request GetAgentRequest) (response GetAgentResponse, err error)

GetAgent Gets information about an agent.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetAgent.go.html to see an example of how to use GetAgent API. A default retry strategy applies to this operation GetAgent()

func (GenerativeAiAgentClient) GetAgentEndpoint 

func (client GenerativeAiAgentClient) GetAgentEndpoint(ctx context.Context, request GetAgentEndpointRequest) (response GetAgentEndpointResponse, err error)

GetAgentEndpoint Gets information about an endpoint.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetAgentEndpoint.go.html to see an example of how to use GetAgentEndpoint API. A default retry strategy applies to this operation GetAgentEndpoint()

func (GenerativeAiAgentClient) GetDataIngestionJob 

func (client GenerativeAiAgentClient) GetDataIngestionJob(ctx context.Context, request GetDataIngestionJobRequest) (response GetDataIngestionJobResponse, err error)

GetDataIngestionJob Gets information about a data ingestion job.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetDataIngestionJob.go.html to see an example of how to use GetDataIngestionJob API. A default retry strategy applies to this operation GetDataIngestionJob()

func (GenerativeAiAgentClient) GetDataIngestionJobLogContent 

func (client GenerativeAiAgentClient) GetDataIngestionJobLogContent(ctx context.Context, request GetDataIngestionJobLogContentRequest) (response GetDataIngestionJobLogContentResponse, err error)

GetDataIngestionJobLogContent Returns the raw log file for the specified data ingestion job in text format.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetDataIngestionJobLogContent.go.html to see an example of how to use GetDataIngestionJobLogContent API. A default retry strategy applies to this operation GetDataIngestionJobLogContent()

func (GenerativeAiAgentClient) GetDataSource 

func (client GenerativeAiAgentClient) GetDataSource(ctx context.Context, request GetDataSourceRequest) (response GetDataSourceResponse, err error)

GetDataSource Gets information about a data source.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetDataSource.go.html to see an example of how to use GetDataSource API. A default retry strategy applies to this operation GetDataSource()

func (GenerativeAiAgentClient) GetKnowledgeBase 

func (client GenerativeAiAgentClient) GetKnowledgeBase(ctx context.Context, request GetKnowledgeBaseRequest) (response GetKnowledgeBaseResponse, err error)

GetKnowledgeBase Gets information about a knowledge base.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetKnowledgeBase.go.html to see an example of how to use GetKnowledgeBase API. A default retry strategy applies to this operation GetKnowledgeBase()

func (GenerativeAiAgentClient) GetWorkRequest 

func (client GenerativeAiAgentClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets the details of a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (GenerativeAiAgentClient) ListAgentEndpoints 

func (client GenerativeAiAgentClient) ListAgentEndpoints(ctx context.Context, request ListAgentEndpointsRequest) (response ListAgentEndpointsResponse, err error)

ListAgentEndpoints Gets a list of endpoints.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListAgentEndpoints.go.html to see an example of how to use ListAgentEndpoints API. A default retry strategy applies to this operation ListAgentEndpoints()

func (GenerativeAiAgentClient) ListAgents 

func (client GenerativeAiAgentClient) ListAgents(ctx context.Context, request ListAgentsRequest) (response ListAgentsResponse, err error)

ListAgents Gets a list of agents.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListAgents.go.html to see an example of how to use ListAgents API. A default retry strategy applies to this operation ListAgents()

func (GenerativeAiAgentClient) ListDataIngestionJobs 

func (client GenerativeAiAgentClient) ListDataIngestionJobs(ctx context.Context, request ListDataIngestionJobsRequest) (response ListDataIngestionJobsResponse, err error)

ListDataIngestionJobs Gets a list of data ingestion jobs.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListDataIngestionJobs.go.html to see an example of how to use ListDataIngestionJobs API. A default retry strategy applies to this operation ListDataIngestionJobs()

func (GenerativeAiAgentClient) ListDataSources 

func (client GenerativeAiAgentClient) ListDataSources(ctx context.Context, request ListDataSourcesRequest) (response ListDataSourcesResponse, err error)

ListDataSources Gets a list of data sources.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListDataSources.go.html to see an example of how to use ListDataSources API. A default retry strategy applies to this operation ListDataSources()

func (GenerativeAiAgentClient) ListKnowledgeBases 

func (client GenerativeAiAgentClient) ListKnowledgeBases(ctx context.Context, request ListKnowledgeBasesRequest) (response ListKnowledgeBasesResponse, err error)

ListKnowledgeBases Gets a list of knowledge bases.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListKnowledgeBases.go.html to see an example of how to use ListKnowledgeBases API. A default retry strategy applies to this operation ListKnowledgeBases()

func (GenerativeAiAgentClient) ListWorkRequestErrors 

func (client GenerativeAiAgentClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Lists the errors for a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (GenerativeAiAgentClient) ListWorkRequestLogs 

func (client GenerativeAiAgentClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Lists the logs for a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (GenerativeAiAgentClient) ListWorkRequests 

func (client GenerativeAiAgentClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (*GenerativeAiAgentClient) SetRegion 

func (client *GenerativeAiAgentClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (GenerativeAiAgentClient) UpdateAgent 

func (client GenerativeAiAgentClient) UpdateAgent(ctx context.Context, request UpdateAgentRequest) (response UpdateAgentResponse, err error)

UpdateAgent Updates an agent.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateAgent.go.html to see an example of how to use UpdateAgent API. A default retry strategy applies to this operation UpdateAgent()

func (GenerativeAiAgentClient) UpdateAgentEndpoint 

func (client GenerativeAiAgentClient) UpdateAgentEndpoint(ctx context.Context, request UpdateAgentEndpointRequest) (response UpdateAgentEndpointResponse, err error)

UpdateAgentEndpoint Updates an endpoint.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateAgentEndpoint.go.html to see an example of how to use UpdateAgentEndpoint API. A default retry strategy applies to this operation UpdateAgentEndpoint()

func (GenerativeAiAgentClient) UpdateDataSource 

func (client GenerativeAiAgentClient) UpdateDataSource(ctx context.Context, request UpdateDataSourceRequest) (response UpdateDataSourceResponse, err error)

UpdateDataSource Updates a data source.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateDataSource.go.html to see an example of how to use UpdateDataSource API. A default retry strategy applies to this operation UpdateDataSource()

func (GenerativeAiAgentClient) UpdateKnowledgeBase 

func (client GenerativeAiAgentClient) UpdateKnowledgeBase(ctx context.Context, request UpdateKnowledgeBaseRequest) (response UpdateKnowledgeBaseResponse, err error)

UpdateKnowledgeBase Updates a knowledge base.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateKnowledgeBase.go.html to see an example of how to use UpdateKnowledgeBase API. A default retry strategy applies to this operation UpdateKnowledgeBase()

type 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
}

GetAgentEndpointRequest wrapper for the GetAgentEndpoint operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetAgentEndpoint.go.html to see an example of how to use GetAgentEndpointRequest.

func (GetAgentEndpointRequest) BinaryRequestBody 

func (request GetAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAgentEndpointRequest) HTTPRequest 

func (request GetAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAgentEndpointRequest) RetryPolicy 

func (request GetAgentEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAgentEndpointRequest) String 

func (request GetAgentEndpointRequest) String() string

func (GetAgentEndpointRequest) ValidateEnumValue 

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

type GetAgentEndpointResponse 

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

GetAgentEndpointResponse wrapper for the GetAgentEndpoint operation

func (GetAgentEndpointResponse) HTTPResponse 

func (response GetAgentEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAgentEndpointResponse) String 

func (response GetAgentEndpointResponse) String() string

type 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
}

GetAgentRequest wrapper for the GetAgent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetAgent.go.html to see an example of how to use GetAgentRequest.

func (GetAgentRequest) BinaryRequestBody 

func (request GetAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAgentRequest) HTTPRequest 

func (request GetAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAgentRequest) RetryPolicy 

func (request GetAgentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAgentRequest) String 

func (request GetAgentRequest) String() string

func (GetAgentRequest) ValidateEnumValue 

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

type GetAgentResponse 

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

GetAgentResponse wrapper for the GetAgent operation

func (GetAgentResponse) HTTPResponse 

func (response GetAgentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAgentResponse) String 

func (response GetAgentResponse) String() string

type 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
}

GetDataIngestionJobLogContentRequest wrapper for the GetDataIngestionJobLogContent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetDataIngestionJobLogContent.go.html to see an example of how to use GetDataIngestionJobLogContentRequest.

func (GetDataIngestionJobLogContentRequest) BinaryRequestBody 

func (request GetDataIngestionJobLogContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDataIngestionJobLogContentRequest) HTTPRequest 

func (request GetDataIngestionJobLogContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDataIngestionJobLogContentRequest) RetryPolicy 

func (request GetDataIngestionJobLogContentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDataIngestionJobLogContentRequest) String 

func (request GetDataIngestionJobLogContentRequest) String() string

func (GetDataIngestionJobLogContentRequest) ValidateEnumValue 

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

type GetDataIngestionJobLogContentResponse 

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

GetDataIngestionJobLogContentResponse wrapper for the GetDataIngestionJobLogContent operation

func (GetDataIngestionJobLogContentResponse) HTTPResponse 

func (response GetDataIngestionJobLogContentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDataIngestionJobLogContentResponse) String 

func (response GetDataIngestionJobLogContentResponse) String() string

type 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
}

GetDataIngestionJobRequest wrapper for the GetDataIngestionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetDataIngestionJob.go.html to see an example of how to use GetDataIngestionJobRequest.

func (GetDataIngestionJobRequest) BinaryRequestBody 

func (request GetDataIngestionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDataIngestionJobRequest) HTTPRequest 

func (request GetDataIngestionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDataIngestionJobRequest) RetryPolicy 

func (request GetDataIngestionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDataIngestionJobRequest) String 

func (request GetDataIngestionJobRequest) String() string

func (GetDataIngestionJobRequest) ValidateEnumValue 

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

type GetDataIngestionJobResponse 

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

GetDataIngestionJobResponse wrapper for the GetDataIngestionJob operation

func (GetDataIngestionJobResponse) HTTPResponse 

func (response GetDataIngestionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDataIngestionJobResponse) String 

func (response GetDataIngestionJobResponse) String() string

type 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
}

GetDataSourceRequest wrapper for the GetDataSource operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetDataSource.go.html to see an example of how to use GetDataSourceRequest.

func (GetDataSourceRequest) BinaryRequestBody 

func (request GetDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDataSourceRequest) HTTPRequest 

func (request GetDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDataSourceRequest) RetryPolicy 

func (request GetDataSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDataSourceRequest) String 

func (request GetDataSourceRequest) String() string

func (GetDataSourceRequest) ValidateEnumValue 

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

type GetDataSourceResponse 

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

GetDataSourceResponse wrapper for the GetDataSource operation

func (GetDataSourceResponse) HTTPResponse 

func (response GetDataSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDataSourceResponse) String 

func (response GetDataSourceResponse) String() string

type 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
}

GetKnowledgeBaseRequest wrapper for the GetKnowledgeBase operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetKnowledgeBase.go.html to see an example of how to use GetKnowledgeBaseRequest.

func (GetKnowledgeBaseRequest) BinaryRequestBody 

func (request GetKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetKnowledgeBaseRequest) HTTPRequest 

func (request GetKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetKnowledgeBaseRequest) RetryPolicy 

func (request GetKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetKnowledgeBaseRequest) String 

func (request GetKnowledgeBaseRequest) String() string

func (GetKnowledgeBaseRequest) ValidateEnumValue 

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

type GetKnowledgeBaseResponse 

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

GetKnowledgeBaseResponse wrapper for the GetKnowledgeBase operation

func (GetKnowledgeBaseResponse) HTTPResponse 

func (response GetKnowledgeBaseResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetKnowledgeBaseResponse) String 

func (response GetKnowledgeBaseResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody 

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue 

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

type GetWorkRequestResponse 

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type IdcsSecret 

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

IdcsSecret The details of IDCS configured as OpenID setting in OpenSearch.

func (IdcsSecret) MarshalJSON 

func (m IdcsSecret) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (IdcsSecret) String 

func (m IdcsSecret) String() string

func (IdcsSecret) ValidateEnumValue 

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

type Index 

type Index struct {

	// The index name in opensearch.
	Name *string `mandatory:"true" json:"name"`

	Schema *IndexSchema `mandatory:"true" json:"schema"`
}

Index OCI OpenSearch index details.

func (Index) String 

func (m Index) String() string

func (Index) ValidateEnumValue 

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

type IndexConfig 

type IndexConfig interface {
}

IndexConfig The index configuration of Knowledge bases.

type IndexConfigIndexConfigTypeEnum 

type IndexConfigIndexConfigTypeEnum string

IndexConfigIndexConfigTypeEnum Enum with underlying type: string 

const (
	IndexConfigIndexConfigTypeDefaultIndexConfig       IndexConfigIndexConfigTypeEnum = "DEFAULT_INDEX_CONFIG"
	IndexConfigIndexConfigTypeOciOpenSearchIndexConfig IndexConfigIndexConfigTypeEnum = "OCI_OPEN_SEARCH_INDEX_CONFIG"
	IndexConfigIndexConfigTypeOciDatabaseConfig        IndexConfigIndexConfigTypeEnum = "OCI_DATABASE_CONFIG"
)

Set of constants representing the allowable values for IndexConfigIndexConfigTypeEnum

func GetIndexConfigIndexConfigTypeEnumValues 

func GetIndexConfigIndexConfigTypeEnumValues() []IndexConfigIndexConfigTypeEnum

GetIndexConfigIndexConfigTypeEnumValues Enumerates the set of values for IndexConfigIndexConfigTypeEnum

func GetMappingIndexConfigIndexConfigTypeEnum 

func GetMappingIndexConfigIndexConfigTypeEnum(val string) (IndexConfigIndexConfigTypeEnum, bool)

GetMappingIndexConfigIndexConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type IndexSchema 

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

IndexSchema The index schema details.

func (IndexSchema) String 

func (m IndexSchema) String() string

func (IndexSchema) ValidateEnumValue 

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

type KnowledgeBase 

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

	KnowledgeBaseStatistics *KnowledgeBaseStatistics `mandatory:"false" json:"knowledgeBaseStatistics"`

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

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

func (KnowledgeBase) String 

func (m KnowledgeBase) String() string

func (*KnowledgeBase) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (KnowledgeBase) ValidateEnumValue 

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

type KnowledgeBaseCollection 

type KnowledgeBaseCollection struct {

	// List of knowledge bases.
	Items []KnowledgeBaseSummary `mandatory:"true" json:"items"`
}

KnowledgeBaseCollection Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata.

func (KnowledgeBaseCollection) String 

func (m KnowledgeBaseCollection) String() string

func (KnowledgeBaseCollection) ValidateEnumValue 

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

type KnowledgeBaseLifecycleStateEnum 

type KnowledgeBaseLifecycleStateEnum string

KnowledgeBaseLifecycleStateEnum Enum with underlying type: string 

const (
	KnowledgeBaseLifecycleStateCreating KnowledgeBaseLifecycleStateEnum = "CREATING"
	KnowledgeBaseLifecycleStateUpdating KnowledgeBaseLifecycleStateEnum = "UPDATING"
	KnowledgeBaseLifecycleStateActive   KnowledgeBaseLifecycleStateEnum = "ACTIVE"
	KnowledgeBaseLifecycleStateInactive KnowledgeBaseLifecycleStateEnum = "INACTIVE"
	KnowledgeBaseLifecycleStateDeleting KnowledgeBaseLifecycleStateEnum = "DELETING"
	KnowledgeBaseLifecycleStateDeleted  KnowledgeBaseLifecycleStateEnum = "DELETED"
	KnowledgeBaseLifecycleStateFailed   KnowledgeBaseLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for KnowledgeBaseLifecycleStateEnum

func GetKnowledgeBaseLifecycleStateEnumValues 

func GetKnowledgeBaseLifecycleStateEnumValues() []KnowledgeBaseLifecycleStateEnum

GetKnowledgeBaseLifecycleStateEnumValues Enumerates the set of values for KnowledgeBaseLifecycleStateEnum

func GetMappingKnowledgeBaseLifecycleStateEnum 

func GetMappingKnowledgeBaseLifecycleStateEnum(val string) (KnowledgeBaseLifecycleStateEnum, bool)

GetMappingKnowledgeBaseLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type KnowledgeBaseStatistics added in v65.81.0 

type KnowledgeBaseStatistics struct {

	// Knowledge Base size in bytes.
	SizeInBytes *int `mandatory:"false" json:"sizeInBytes"`
}

KnowledgeBaseStatistics Statistics for Default Knowledge Base.

func (KnowledgeBaseStatistics) String added in v65.81.0 

func (m KnowledgeBaseStatistics) String() string

func (KnowledgeBaseStatistics) ValidateEnumValue added in v65.81.0 

func (m KnowledgeBaseStatistics) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type KnowledgeBaseSummary 

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

KnowledgeBaseSummary Summary information about a knowledge base.

func (KnowledgeBaseSummary) String 

func (m KnowledgeBaseSummary) String() string

func (KnowledgeBaseSummary) ValidateEnumValue 

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

type 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
}

ListAgentEndpointsRequest wrapper for the ListAgentEndpoints operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListAgentEndpoints.go.html to see an example of how to use ListAgentEndpointsRequest.

func (ListAgentEndpointsRequest) BinaryRequestBody 

func (request ListAgentEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAgentEndpointsRequest) HTTPRequest 

func (request ListAgentEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAgentEndpointsRequest) RetryPolicy 

func (request ListAgentEndpointsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAgentEndpointsRequest) String 

func (request ListAgentEndpointsRequest) String() string

func (ListAgentEndpointsRequest) ValidateEnumValue 

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

type ListAgentEndpointsResponse 

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

ListAgentEndpointsResponse wrapper for the ListAgentEndpoints operation

func (ListAgentEndpointsResponse) HTTPResponse 

func (response ListAgentEndpointsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAgentEndpointsResponse) String 

func (response ListAgentEndpointsResponse) String() string

type ListAgentEndpointsSortByEnum 

type ListAgentEndpointsSortByEnum string

ListAgentEndpointsSortByEnum Enum with underlying type: string 

const (
	ListAgentEndpointsSortByTimecreated ListAgentEndpointsSortByEnum = "timeCreated"
	ListAgentEndpointsSortByDisplayname ListAgentEndpointsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAgentEndpointsSortByEnum

func GetListAgentEndpointsSortByEnumValues 

func GetListAgentEndpointsSortByEnumValues() []ListAgentEndpointsSortByEnum

GetListAgentEndpointsSortByEnumValues Enumerates the set of values for ListAgentEndpointsSortByEnum

func GetMappingListAgentEndpointsSortByEnum 

func GetMappingListAgentEndpointsSortByEnum(val string) (ListAgentEndpointsSortByEnum, bool)

GetMappingListAgentEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAgentEndpointsSortOrderEnum 

type ListAgentEndpointsSortOrderEnum string

ListAgentEndpointsSortOrderEnum Enum with underlying type: string 

const (
	ListAgentEndpointsSortOrderAsc  ListAgentEndpointsSortOrderEnum = "ASC"
	ListAgentEndpointsSortOrderDesc ListAgentEndpointsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAgentEndpointsSortOrderEnum

func GetListAgentEndpointsSortOrderEnumValues 

func GetListAgentEndpointsSortOrderEnumValues() []ListAgentEndpointsSortOrderEnum

GetListAgentEndpointsSortOrderEnumValues Enumerates the set of values for ListAgentEndpointsSortOrderEnum

func GetMappingListAgentEndpointsSortOrderEnum 

func GetMappingListAgentEndpointsSortOrderEnum(val string) (ListAgentEndpointsSortOrderEnum, bool)

GetMappingListAgentEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListAgentsRequest wrapper for the ListAgents operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListAgents.go.html to see an example of how to use ListAgentsRequest.

func (ListAgentsRequest) BinaryRequestBody 

func (request ListAgentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAgentsRequest) HTTPRequest 

func (request ListAgentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAgentsRequest) RetryPolicy 

func (request ListAgentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAgentsRequest) String 

func (request ListAgentsRequest) String() string

func (ListAgentsRequest) ValidateEnumValue 

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

type ListAgentsResponse 

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

ListAgentsResponse wrapper for the ListAgents operation

func (ListAgentsResponse) HTTPResponse 

func (response ListAgentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAgentsResponse) String 

func (response ListAgentsResponse) String() string

type ListAgentsSortByEnum 

type ListAgentsSortByEnum string

ListAgentsSortByEnum Enum with underlying type: string 

const (
	ListAgentsSortByTimecreated ListAgentsSortByEnum = "timeCreated"
	ListAgentsSortByDisplayname ListAgentsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAgentsSortByEnum

func GetListAgentsSortByEnumValues 

func GetListAgentsSortByEnumValues() []ListAgentsSortByEnum

GetListAgentsSortByEnumValues Enumerates the set of values for ListAgentsSortByEnum

func GetMappingListAgentsSortByEnum 

func GetMappingListAgentsSortByEnum(val string) (ListAgentsSortByEnum, bool)

GetMappingListAgentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAgentsSortOrderEnum 

type ListAgentsSortOrderEnum string

ListAgentsSortOrderEnum Enum with underlying type: string 

const (
	ListAgentsSortOrderAsc  ListAgentsSortOrderEnum = "ASC"
	ListAgentsSortOrderDesc ListAgentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAgentsSortOrderEnum

func GetListAgentsSortOrderEnumValues 

func GetListAgentsSortOrderEnumValues() []ListAgentsSortOrderEnum

GetListAgentsSortOrderEnumValues Enumerates the set of values for ListAgentsSortOrderEnum

func GetMappingListAgentsSortOrderEnum 

func GetMappingListAgentsSortOrderEnum(val string) (ListAgentsSortOrderEnum, bool)

GetMappingListAgentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDataIngestionJobsRequest wrapper for the ListDataIngestionJobs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListDataIngestionJobs.go.html to see an example of how to use ListDataIngestionJobsRequest.

func (ListDataIngestionJobsRequest) BinaryRequestBody 

func (request ListDataIngestionJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDataIngestionJobsRequest) HTTPRequest 

func (request ListDataIngestionJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDataIngestionJobsRequest) RetryPolicy 

func (request ListDataIngestionJobsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDataIngestionJobsRequest) String 

func (request ListDataIngestionJobsRequest) String() string

func (ListDataIngestionJobsRequest) ValidateEnumValue 

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

type ListDataIngestionJobsResponse 

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

ListDataIngestionJobsResponse wrapper for the ListDataIngestionJobs operation

func (ListDataIngestionJobsResponse) HTTPResponse 

func (response ListDataIngestionJobsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDataIngestionJobsResponse) String 

func (response ListDataIngestionJobsResponse) String() string

type ListDataIngestionJobsSortByEnum 

type ListDataIngestionJobsSortByEnum string

ListDataIngestionJobsSortByEnum Enum with underlying type: string 

const (
	ListDataIngestionJobsSortByTimecreated ListDataIngestionJobsSortByEnum = "timeCreated"
	ListDataIngestionJobsSortByDisplayname ListDataIngestionJobsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDataIngestionJobsSortByEnum

func GetListDataIngestionJobsSortByEnumValues 

func GetListDataIngestionJobsSortByEnumValues() []ListDataIngestionJobsSortByEnum

GetListDataIngestionJobsSortByEnumValues Enumerates the set of values for ListDataIngestionJobsSortByEnum

func GetMappingListDataIngestionJobsSortByEnum 

func GetMappingListDataIngestionJobsSortByEnum(val string) (ListDataIngestionJobsSortByEnum, bool)

GetMappingListDataIngestionJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDataIngestionJobsSortOrderEnum 

type ListDataIngestionJobsSortOrderEnum string

ListDataIngestionJobsSortOrderEnum Enum with underlying type: string 

const (
	ListDataIngestionJobsSortOrderAsc  ListDataIngestionJobsSortOrderEnum = "ASC"
	ListDataIngestionJobsSortOrderDesc ListDataIngestionJobsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDataIngestionJobsSortOrderEnum

func GetListDataIngestionJobsSortOrderEnumValues 

func GetListDataIngestionJobsSortOrderEnumValues() []ListDataIngestionJobsSortOrderEnum

GetListDataIngestionJobsSortOrderEnumValues Enumerates the set of values for ListDataIngestionJobsSortOrderEnum

func GetMappingListDataIngestionJobsSortOrderEnum 

func GetMappingListDataIngestionJobsSortOrderEnum(val string) (ListDataIngestionJobsSortOrderEnum, bool)

GetMappingListDataIngestionJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDataSourcesRequest wrapper for the ListDataSources operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListDataSources.go.html to see an example of how to use ListDataSourcesRequest.

func (ListDataSourcesRequest) BinaryRequestBody 

func (request ListDataSourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDataSourcesRequest) HTTPRequest 

func (request ListDataSourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDataSourcesRequest) RetryPolicy 

func (request ListDataSourcesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDataSourcesRequest) String 

func (request ListDataSourcesRequest) String() string

func (ListDataSourcesRequest) ValidateEnumValue 

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

type ListDataSourcesResponse 

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

ListDataSourcesResponse wrapper for the ListDataSources operation

func (ListDataSourcesResponse) HTTPResponse 

func (response ListDataSourcesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDataSourcesResponse) String 

func (response ListDataSourcesResponse) String() string

type ListDataSourcesSortByEnum 

type ListDataSourcesSortByEnum string

ListDataSourcesSortByEnum Enum with underlying type: string 

const (
	ListDataSourcesSortByTimecreated ListDataSourcesSortByEnum = "timeCreated"
	ListDataSourcesSortByDisplayname ListDataSourcesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDataSourcesSortByEnum

func GetListDataSourcesSortByEnumValues 

func GetListDataSourcesSortByEnumValues() []ListDataSourcesSortByEnum

GetListDataSourcesSortByEnumValues Enumerates the set of values for ListDataSourcesSortByEnum

func GetMappingListDataSourcesSortByEnum 

func GetMappingListDataSourcesSortByEnum(val string) (ListDataSourcesSortByEnum, bool)

GetMappingListDataSourcesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDataSourcesSortOrderEnum 

type ListDataSourcesSortOrderEnum string

ListDataSourcesSortOrderEnum Enum with underlying type: string 

const (
	ListDataSourcesSortOrderAsc  ListDataSourcesSortOrderEnum = "ASC"
	ListDataSourcesSortOrderDesc ListDataSourcesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDataSourcesSortOrderEnum

func GetListDataSourcesSortOrderEnumValues 

func GetListDataSourcesSortOrderEnumValues() []ListDataSourcesSortOrderEnum

GetListDataSourcesSortOrderEnumValues Enumerates the set of values for ListDataSourcesSortOrderEnum

func GetMappingListDataSourcesSortOrderEnum 

func GetMappingListDataSourcesSortOrderEnum(val string) (ListDataSourcesSortOrderEnum, bool)

GetMappingListDataSourcesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListKnowledgeBasesRequest wrapper for the ListKnowledgeBases operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListKnowledgeBases.go.html to see an example of how to use ListKnowledgeBasesRequest.

func (ListKnowledgeBasesRequest) BinaryRequestBody 

func (request ListKnowledgeBasesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListKnowledgeBasesRequest) HTTPRequest 

func (request ListKnowledgeBasesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListKnowledgeBasesRequest) RetryPolicy 

func (request ListKnowledgeBasesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListKnowledgeBasesRequest) String 

func (request ListKnowledgeBasesRequest) String() string

func (ListKnowledgeBasesRequest) ValidateEnumValue 

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

type ListKnowledgeBasesResponse 

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

ListKnowledgeBasesResponse wrapper for the ListKnowledgeBases operation

func (ListKnowledgeBasesResponse) HTTPResponse 

func (response ListKnowledgeBasesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListKnowledgeBasesResponse) String 

func (response ListKnowledgeBasesResponse) String() string

type ListKnowledgeBasesSortByEnum 

type ListKnowledgeBasesSortByEnum string

ListKnowledgeBasesSortByEnum Enum with underlying type: string 

const (
	ListKnowledgeBasesSortByTimecreated ListKnowledgeBasesSortByEnum = "timeCreated"
	ListKnowledgeBasesSortByDisplayname ListKnowledgeBasesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListKnowledgeBasesSortByEnum

func GetListKnowledgeBasesSortByEnumValues 

func GetListKnowledgeBasesSortByEnumValues() []ListKnowledgeBasesSortByEnum

GetListKnowledgeBasesSortByEnumValues Enumerates the set of values for ListKnowledgeBasesSortByEnum

func GetMappingListKnowledgeBasesSortByEnum 

func GetMappingListKnowledgeBasesSortByEnum(val string) (ListKnowledgeBasesSortByEnum, bool)

GetMappingListKnowledgeBasesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKnowledgeBasesSortOrderEnum 

type ListKnowledgeBasesSortOrderEnum string

ListKnowledgeBasesSortOrderEnum Enum with underlying type: string 

const (
	ListKnowledgeBasesSortOrderAsc  ListKnowledgeBasesSortOrderEnum = "ASC"
	ListKnowledgeBasesSortOrderDesc ListKnowledgeBasesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListKnowledgeBasesSortOrderEnum

func GetListKnowledgeBasesSortOrderEnumValues 

func GetListKnowledgeBasesSortOrderEnumValues() []ListKnowledgeBasesSortOrderEnum

GetListKnowledgeBasesSortOrderEnumValues Enumerates the set of values for ListKnowledgeBasesSortOrderEnum

func GetMappingListKnowledgeBasesSortOrderEnum 

func GetMappingListKnowledgeBasesSortOrderEnum(val string) (ListKnowledgeBasesSortOrderEnum, bool)

GetMappingListKnowledgeBasesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

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

type ListWorkRequestErrorsResponse 

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody 

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue 

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

type ListWorkRequestLogsResponse 

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody 

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue 

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

type ListWorkRequestsResponse 

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsStatusEnum 

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues 

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum 

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ObjectStoragePrefix 

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

ObjectStoragePrefix The details of OCI Object Storage object.

func (ObjectStoragePrefix) String 

func (m ObjectStoragePrefix) String() string

func (ObjectStoragePrefix) ValidateEnumValue 

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

type OciDatabaseConfig 

type OciDatabaseConfig struct {
	DatabaseConnection DatabaseConnection `mandatory:"true" json:"databaseConnection"`

	// Array of Database functions to be used.
	DatabaseFunctions []DatabaseFunction `mandatory:"true" json:"databaseFunctions"`
}

OciDatabaseConfig The details of the customer Database Connection.

func (OciDatabaseConfig) MarshalJSON 

func (m OciDatabaseConfig) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OciDatabaseConfig) String 

func (m OciDatabaseConfig) String() string

func (*OciDatabaseConfig) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (OciDatabaseConfig) ValidateEnumValue 

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

type OciObjectStorageDataSourceConfig 

type OciObjectStorageDataSourceConfig struct {

	// Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion.
	ShouldEnableMultiModality *bool `mandatory:"false" json:"shouldEnableMultiModality"`

	// The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
	ObjectStoragePrefixes []ObjectStoragePrefix `mandatory:"false" json:"objectStoragePrefixes"`
}

OciObjectStorageDataSourceConfig The details of OCI Search with OpenSearch data source information.

func (OciObjectStorageDataSourceConfig) GetShouldEnableMultiModality added in v65.81.0 

func (m OciObjectStorageDataSourceConfig) GetShouldEnableMultiModality() *bool

GetShouldEnableMultiModality returns ShouldEnableMultiModality

func (OciObjectStorageDataSourceConfig) MarshalJSON 

func (m OciObjectStorageDataSourceConfig) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OciObjectStorageDataSourceConfig) String 

func (m OciObjectStorageDataSourceConfig) String() string

func (OciObjectStorageDataSourceConfig) ValidateEnumValue 

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

type OciOpenSearchIndexConfig 

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

OciOpenSearchIndexConfig The details of customer managed OCI OpenSearch.

func (OciOpenSearchIndexConfig) MarshalJSON 

func (m OciOpenSearchIndexConfig) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OciOpenSearchIndexConfig) String 

func (m OciOpenSearchIndexConfig) String() string

func (*OciOpenSearchIndexConfig) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (OciOpenSearchIndexConfig) ValidateEnumValue 

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

type OperationStatusEnum 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

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"
	OperationTypeCreateTool             OperationTypeEnum = "CREATE_TOOL"
	OperationTypeUpdateTool             OperationTypeEnum = "UPDATE_TOOL"
	OperationTypeDeleteTool             OperationTypeEnum = "DELETE_TOOL"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type SecretDetail 

type SecretDetail interface {
}

SecretDetail The details of configured security configuration on OpenSearch.

type SecretDetailTypeEnum 

type SecretDetailTypeEnum string

SecretDetailTypeEnum Enum with underlying type: string 

const (
	SecretDetailTypeIdcsSecret      SecretDetailTypeEnum = "IDCS_SECRET"
	SecretDetailTypeBasicAuthSecret SecretDetailTypeEnum = "BASIC_AUTH_SECRET"
)

Set of constants representing the allowable values for SecretDetailTypeEnum

func GetMappingSecretDetailTypeEnum 

func GetMappingSecretDetailTypeEnum(val string) (SecretDetailTypeEnum, bool)

GetMappingSecretDetailTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSecretDetailTypeEnumValues 

func GetSecretDetailTypeEnumValues() []SecretDetailTypeEnum

GetSecretDetailTypeEnumValues Enumerates the set of values for SecretDetailTypeEnum

type SessionConfig 

type SessionConfig struct {

	// The session will become inactive after this timeout.
	IdleTimeoutInSeconds *int `mandatory:"false" json:"idleTimeoutInSeconds"`
}

SessionConfig Session Configuration on AgentEndpoint.

func (SessionConfig) String 

func (m SessionConfig) String() string

func (SessionConfig) ValidateEnumValue 

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

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateAgentDetails 

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

UpdateAgentDetails The data to update an agent.

func (UpdateAgentDetails) String 

func (m UpdateAgentDetails) String() string

func (UpdateAgentDetails) ValidateEnumValue 

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

type UpdateAgentEndpointDetails 

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

UpdateAgentEndpointDetails The data to update an endpoint.

func (UpdateAgentEndpointDetails) String 

func (m UpdateAgentEndpointDetails) String() string

func (UpdateAgentEndpointDetails) ValidateEnumValue 

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

type 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
}

UpdateAgentEndpointRequest wrapper for the UpdateAgentEndpoint operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateAgentEndpoint.go.html to see an example of how to use UpdateAgentEndpointRequest.

func (UpdateAgentEndpointRequest) BinaryRequestBody 

func (request UpdateAgentEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAgentEndpointRequest) HTTPRequest 

func (request UpdateAgentEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAgentEndpointRequest) RetryPolicy 

func (request UpdateAgentEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAgentEndpointRequest) String 

func (request UpdateAgentEndpointRequest) String() string

func (UpdateAgentEndpointRequest) ValidateEnumValue 

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

type UpdateAgentEndpointResponse 

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

UpdateAgentEndpointResponse wrapper for the UpdateAgentEndpoint operation

func (UpdateAgentEndpointResponse) HTTPResponse 

func (response UpdateAgentEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAgentEndpointResponse) String 

func (response UpdateAgentEndpointResponse) String() string

type 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
}

UpdateAgentRequest wrapper for the UpdateAgent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateAgent.go.html to see an example of how to use UpdateAgentRequest.

func (UpdateAgentRequest) BinaryRequestBody 

func (request UpdateAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAgentRequest) HTTPRequest 

func (request UpdateAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAgentRequest) RetryPolicy 

func (request UpdateAgentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAgentRequest) String 

func (request UpdateAgentRequest) String() string

func (UpdateAgentRequest) ValidateEnumValue 

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

type UpdateAgentResponse 

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

UpdateAgentResponse wrapper for the UpdateAgent operation

func (UpdateAgentResponse) HTTPResponse 

func (response UpdateAgentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAgentResponse) String 

func (response UpdateAgentResponse) String() string

type UpdateDataSourceDetails 

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

UpdateDataSourceDetails The data to update a data source.

func (UpdateDataSourceDetails) String 

func (m UpdateDataSourceDetails) String() string

func (*UpdateDataSourceDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (UpdateDataSourceDetails) ValidateEnumValue 

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

type 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
}

UpdateDataSourceRequest wrapper for the UpdateDataSource operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateDataSource.go.html to see an example of how to use UpdateDataSourceRequest.

func (UpdateDataSourceRequest) BinaryRequestBody 

func (request UpdateDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDataSourceRequest) HTTPRequest 

func (request UpdateDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDataSourceRequest) RetryPolicy 

func (request UpdateDataSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDataSourceRequest) String 

func (request UpdateDataSourceRequest) String() string

func (UpdateDataSourceRequest) ValidateEnumValue 

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

type UpdateDataSourceResponse 

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

UpdateDataSourceResponse wrapper for the UpdateDataSource operation

func (UpdateDataSourceResponse) HTTPResponse 

func (response UpdateDataSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDataSourceResponse) String 

func (response UpdateDataSourceResponse) String() string

type UpdateKnowledgeBaseDetails 

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

UpdateKnowledgeBaseDetails The data to update a knowledge base.

func (UpdateKnowledgeBaseDetails) String 

func (m UpdateKnowledgeBaseDetails) String() string

func (*UpdateKnowledgeBaseDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (UpdateKnowledgeBaseDetails) ValidateEnumValue 

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

type 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
}

UpdateKnowledgeBaseRequest wrapper for the UpdateKnowledgeBase operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaiagent/UpdateKnowledgeBase.go.html to see an example of how to use UpdateKnowledgeBaseRequest.

func (UpdateKnowledgeBaseRequest) BinaryRequestBody 

func (request UpdateKnowledgeBaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateKnowledgeBaseRequest) HTTPRequest 

func (request UpdateKnowledgeBaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateKnowledgeBaseRequest) RetryPolicy 

func (request UpdateKnowledgeBaseRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateKnowledgeBaseRequest) String 

func (request UpdateKnowledgeBaseRequest) String() string

func (UpdateKnowledgeBaseRequest) ValidateEnumValue 

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

type UpdateKnowledgeBaseResponse 

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

UpdateKnowledgeBaseResponse wrapper for the UpdateKnowledgeBase operation

func (UpdateKnowledgeBaseResponse) HTTPResponse 

func (response UpdateKnowledgeBaseResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateKnowledgeBaseResponse) String 

func (response UpdateKnowledgeBaseResponse) String() string

type WorkRequest 

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

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.

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

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

type WorkRequestError 

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

WorkRequestError An error encountered while performing an operation that is tracked by a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

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

type WorkRequestErrorCollection 

type WorkRequestErrorCollection struct {

	// A list of work request errors.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue 

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

type WorkRequestLogEntry 

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

WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue 

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

type WorkRequestLogEntryCollection 

type WorkRequestLogEntryCollection struct {

	// A list of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

func (WorkRequestLogEntryCollection) String 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue 

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

type WorkRequestResource 

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

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

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

type WorkRequestResourceMetadataKeyEnum 

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string 

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum 

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceMetadataKeyEnumValues 

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary 

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

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue 

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

type WorkRequestSummaryCollection 

type WorkRequestSummaryCollection struct {

	// A list of work requests.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

func (WorkRequestSummaryCollection) String 

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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