func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetApiKeyItemStateEnumStringValues() []string
GetApiKeyItemStateEnumStringValues Enumerates the set of values in String for ApiKeyItemStateEnum
func GetApiKeyLifecycleStateEnumStringValues() []string
GetApiKeyLifecycleStateEnumStringValues Enumerates the set of values in String for ApiKeyLifecycleStateEnum
func GetArtifactArtifactTypeEnumStringValues() []string
GetArtifactArtifactTypeEnumStringValues Enumerates the set of values in String for ArtifactArtifactTypeEnum
func GetArtifactStatusEnumStringValues() []string
GetArtifactStatusEnumStringValues Enumerates the set of values in String for ArtifactStatusEnum
func GetConnectorConfigurationTypeEnumStringValues() []string
GetConnectorConfigurationTypeEnumStringValues Enumerates the set of values in String for ConnectorConfigurationTypeEnum
func GetContentModerationConfigModeEnumStringValues() []string
GetContentModerationConfigModeEnumStringValues Enumerates the set of values in String for ContentModerationConfigModeEnum
func GetCreateArtifactDetailsArtifactTypeEnumStringValues() []string
GetCreateArtifactDetailsArtifactTypeEnumStringValues Enumerates the set of values in String for CreateArtifactDetailsArtifactTypeEnum
func GetCreateDataSourceDetailsConnectionTypeEnumStringValues() []string
GetCreateDataSourceDetailsConnectionTypeEnumStringValues Enumerates the set of values in String for CreateDataSourceDetailsConnectionTypeEnum
func GetCreateSchemasDetailsConnectionTypeEnumStringValues() []string
GetCreateSchemasDetailsConnectionTypeEnumStringValues Enumerates the set of values in String for CreateSchemasDetailsConnectionTypeEnum
func GetDataSourceDetailsConnectionTypeEnumStringValues() []string
GetDataSourceDetailsConnectionTypeEnumStringValues Enumerates the set of values in String for DataSourceDetailsConnectionTypeEnum
func GetDatasetDatasetTypeEnumStringValues() []string
GetDatasetDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDatasetTypeEnum
func GetDedicatedAiClusterCapacityCapacityTypeEnumStringValues() []string
GetDedicatedAiClusterCapacityCapacityTypeEnumStringValues Enumerates the set of values in String for DedicatedAiClusterCapacityCapacityTypeEnum
func GetDedicatedAiClusterLifecycleStateEnumStringValues() []string
GetDedicatedAiClusterLifecycleStateEnumStringValues Enumerates the set of values in String for DedicatedAiClusterLifecycleStateEnum
func GetDedicatedAiClusterTypeEnumStringValues() []string
GetDedicatedAiClusterTypeEnumStringValues Enumerates the set of values in String for DedicatedAiClusterTypeEnum
func GetDedicatedAiClusterUnitShapeEnumStringValues() []string
GetDedicatedAiClusterUnitShapeEnumStringValues Enumerates the set of values in String for DedicatedAiClusterUnitShapeEnum
func GetEndpointLifecycleStateEnumStringValues() []string
GetEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for EndpointLifecycleStateEnum
func GetEnvironmentVariableTypeEnumStringValues() []string
GetEnvironmentVariableTypeEnumStringValues Enumerates the set of values in String for EnvironmentVariableTypeEnum
func GetFileSyncIngestionLogsStatusEnumStringValues() []string
GetFileSyncIngestionLogsStatusEnumStringValues Enumerates the set of values in String for FileSyncIngestionLogsStatusEnum
func GetGenerativeAiPrivateEndpointLifecycleStateEnumStringValues() []string
GetGenerativeAiPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for GenerativeAiPrivateEndpointLifecycleStateEnum
func GetGenerativeAiPrivateEndpointResourceTypeEnumStringValues() []string
GetGenerativeAiPrivateEndpointResourceTypeEnumStringValues Enumerates the set of values in String for GenerativeAiPrivateEndpointResourceTypeEnum
func GetGenerativeAiProjectLifecycleStateEnumStringValues() []string
GetGenerativeAiProjectLifecycleStateEnumStringValues Enumerates the set of values in String for GenerativeAiProjectLifecycleStateEnum
func GetHostedApplicationLifecycleStateEnumStringValues() []string
GetHostedApplicationLifecycleStateEnumStringValues Enumerates the set of values in String for HostedApplicationLifecycleStateEnum
func GetHostedApplicationStorageLifecycleStateEnumStringValues() []string
GetHostedApplicationStorageLifecycleStateEnumStringValues Enumerates the set of values in String for HostedApplicationStorageLifecycleStateEnum
func GetHostedApplicationStorageStorageTypeEnumStringValues() []string
GetHostedApplicationStorageStorageTypeEnumStringValues Enumerates the set of values in String for HostedApplicationStorageStorageTypeEnum
func GetHostedApplicationStorageSummaryStorageTypeEnumStringValues() []string
GetHostedApplicationStorageSummaryStorageTypeEnumStringValues Enumerates the set of values in String for HostedApplicationStorageSummaryStorageTypeEnum
func GetHostedDeploymentLifecycleStateEnumStringValues() []string
GetHostedDeploymentLifecycleStateEnumStringValues Enumerates the set of values in String for HostedDeploymentLifecycleStateEnum
func GetImportedModelCapabilityEnumStringValues() []string
GetImportedModelCapabilityEnumStringValues Enumerates the set of values in String for ImportedModelCapabilityEnum
func GetImportedModelLifecycleStateEnumStringValues() []string
GetImportedModelLifecycleStateEnumStringValues Enumerates the set of values in String for ImportedModelLifecycleStateEnum
func GetInboundAuthConfigInboundAuthConfigTypeEnumStringValues() []string
GetInboundAuthConfigInboundAuthConfigTypeEnumStringValues Enumerates the set of values in String for InboundAuthConfigInboundAuthConfigTypeEnum
func GetInboundNetworkingConfigEndpointModeEnumStringValues() []string
GetInboundNetworkingConfigEndpointModeEnumStringValues Enumerates the set of values in String for InboundNetworkingConfigEndpointModeEnum
func GetListApiKeysSortByEnumStringValues() []string
GetListApiKeysSortByEnumStringValues Enumerates the set of values in String for ListApiKeysSortByEnum
func GetListApiKeysSortOrderEnumStringValues() []string
GetListApiKeysSortOrderEnumStringValues Enumerates the set of values in String for ListApiKeysSortOrderEnum
func GetListDedicatedAiClustersSortByEnumStringValues() []string
GetListDedicatedAiClustersSortByEnumStringValues Enumerates the set of values in String for ListDedicatedAiClustersSortByEnum
func GetListDedicatedAiClustersSortOrderEnumStringValues() []string
GetListDedicatedAiClustersSortOrderEnumStringValues Enumerates the set of values in String for ListDedicatedAiClustersSortOrderEnum
func GetListEndpointsSortByEnumStringValues() []string
GetListEndpointsSortByEnumStringValues Enumerates the set of values in String for ListEndpointsSortByEnum
func GetListEndpointsSortOrderEnumStringValues() []string
GetListEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListEndpointsSortOrderEnum
func GetListGenerativeAiPrivateEndpointsSortByEnumStringValues() []string
GetListGenerativeAiPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListGenerativeAiPrivateEndpointsSortByEnum
func GetListGenerativeAiPrivateEndpointsSortOrderEnumStringValues() []string
GetListGenerativeAiPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListGenerativeAiPrivateEndpointsSortOrderEnum
func GetListGenerativeAiProjectsSortByEnumStringValues() []string
GetListGenerativeAiProjectsSortByEnumStringValues Enumerates the set of values in String for ListGenerativeAiProjectsSortByEnum
func GetListGenerativeAiProjectsSortOrderEnumStringValues() []string
GetListGenerativeAiProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListGenerativeAiProjectsSortOrderEnum
func GetListHostedApplicationStoragesSortByEnumStringValues() []string
GetListHostedApplicationStoragesSortByEnumStringValues Enumerates the set of values in String for ListHostedApplicationStoragesSortByEnum
func GetListHostedApplicationStoragesSortOrderEnumStringValues() []string
GetListHostedApplicationStoragesSortOrderEnumStringValues Enumerates the set of values in String for ListHostedApplicationStoragesSortOrderEnum
func GetListHostedApplicationsSortByEnumStringValues() []string
GetListHostedApplicationsSortByEnumStringValues Enumerates the set of values in String for ListHostedApplicationsSortByEnum
func GetListHostedApplicationsSortOrderEnumStringValues() []string
GetListHostedApplicationsSortOrderEnumStringValues Enumerates the set of values in String for ListHostedApplicationsSortOrderEnum
func GetListHostedDeploymentsSortByEnumStringValues() []string
GetListHostedDeploymentsSortByEnumStringValues Enumerates the set of values in String for ListHostedDeploymentsSortByEnum
func GetListHostedDeploymentsSortOrderEnumStringValues() []string
GetListHostedDeploymentsSortOrderEnumStringValues Enumerates the set of values in String for ListHostedDeploymentsSortOrderEnum
func GetListImportedModelsSortByEnumStringValues() []string
GetListImportedModelsSortByEnumStringValues Enumerates the set of values in String for ListImportedModelsSortByEnum
func GetListImportedModelsSortOrderEnumStringValues() []string
GetListImportedModelsSortOrderEnumStringValues Enumerates the set of values in String for ListImportedModelsSortOrderEnum
func GetListModelsSortByEnumStringValues() []string
GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum
func GetListModelsSortOrderEnumStringValues() []string
GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum
func GetListSemanticStoresLifecycleStateEnumStringValues() []string
GetListSemanticStoresLifecycleStateEnumStringValues Enumerates the set of values in String for ListSemanticStoresLifecycleStateEnum
func GetListSemanticStoresSortByEnumStringValues() []string
GetListSemanticStoresSortByEnumStringValues Enumerates the set of values in String for ListSemanticStoresSortByEnum
func GetListSemanticStoresSortOrderEnumStringValues() []string
GetListSemanticStoresSortOrderEnumStringValues Enumerates the set of values in String for ListSemanticStoresSortOrderEnum
func GetListVectorStoreConnectorFileSyncIngestionLogsSortByEnumStringValues() []string
GetListVectorStoreConnectorFileSyncIngestionLogsSortByEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum
func GetListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnumStringValues() []string
GetListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum
func GetListVectorStoreConnectorFileSyncsSortByEnumStringValues() []string
GetListVectorStoreConnectorFileSyncsSortByEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorFileSyncsSortByEnum
func GetListVectorStoreConnectorFileSyncsSortOrderEnumStringValues() []string
GetListVectorStoreConnectorFileSyncsSortOrderEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorFileSyncsSortOrderEnum
func GetListVectorStoreConnectorIngestionLogsSortByEnumStringValues() []string
GetListVectorStoreConnectorIngestionLogsSortByEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorIngestionLogsSortByEnum
func GetListVectorStoreConnectorIngestionLogsSortOrderEnumStringValues() []string
GetListVectorStoreConnectorIngestionLogsSortOrderEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorIngestionLogsSortOrderEnum
func GetListVectorStoreConnectorsSortByEnumStringValues() []string
GetListVectorStoreConnectorsSortByEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorsSortByEnum
func GetListVectorStoreConnectorsSortOrderEnumStringValues() []string
GetListVectorStoreConnectorsSortOrderEnumStringValues Enumerates the set of values in String for ListVectorStoreConnectorsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetLlmSelectionLlmSelectionTypeEnumStringValues() []string
GetLlmSelectionLlmSelectionTypeEnumStringValues Enumerates the set of values in String for LlmSelectionLlmSelectionTypeEnum
func GetModelCapabilityEnumStringValues() []string
GetModelCapabilityEnumStringValues Enumerates the set of values in String for ModelCapabilityEnum
func GetModelConfigModelConfigTypeEnumStringValues() []string
GetModelConfigModelConfigTypeEnumStringValues Enumerates the set of values in String for ModelConfigModelConfigTypeEnum
func GetModelDataSourceSourceTypeEnumStringValues() []string
GetModelDataSourceSourceTypeEnumStringValues Enumerates the set of values in String for ModelDataSourceSourceTypeEnum
func GetModelLifecycleStateEnumStringValues() []string
GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum
func GetModelMetricsModelMetricsTypeEnumStringValues() []string
GetModelMetricsModelMetricsTypeEnumStringValues Enumerates the set of values in String for ModelMetricsModelMetricsTypeEnum
func GetModelTypeEnumStringValues() []string
GetModelTypeEnumStringValues Enumerates the set of values in String for ModelTypeEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetOutboundNetworkingConfigNetworkModeEnumStringValues() []string
GetOutboundNetworkingConfigNetworkModeEnumStringValues Enumerates the set of values in String for OutboundNetworkingConfigNetworkModeEnum
func GetRefreshScheduleDetailsTypeEnumStringValues() []string
GetRefreshScheduleDetailsTypeEnumStringValues Enumerates the set of values in String for RefreshScheduleDetailsTypeEnum
func GetScalingConfigScalingTypeEnumStringValues() []string
GetScalingConfigScalingTypeEnumStringValues Enumerates the set of values in String for ScalingConfigScalingTypeEnum
func GetScheduleConfigConfigTypeEnumStringValues() []string
GetScheduleConfigConfigTypeEnumStringValues Enumerates the set of values in String for ScheduleConfigConfigTypeEnum
func GetScheduleConfigStateEnumStringValues() []string
GetScheduleConfigStateEnumStringValues Enumerates the set of values in String for ScheduleConfigStateEnum
func GetScheduleIntervalConfigFrequencyEnumStringValues() []string
GetScheduleIntervalConfigFrequencyEnumStringValues Enumerates the set of values in String for ScheduleIntervalConfigFrequencyEnum
func GetSchemasDetailsConnectionTypeEnumStringValues() []string
GetSchemasDetailsConnectionTypeEnumStringValues Enumerates the set of values in String for SchemasDetailsConnectionTypeEnum
func GetSemanticStoreLifecycleStateEnumStringValues() []string
GetSemanticStoreLifecycleStateEnumStringValues Enumerates the set of values in String for SemanticStoreLifecycleStateEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTrainingConfigTrainingConfigTypeEnumStringValues() []string
GetTrainingConfigTrainingConfigTypeEnumStringValues Enumerates the set of values in String for TrainingConfigTrainingConfigTypeEnum
func GetVectorStoreConnectorFileSyncLifecycleStateEnumStringValues() []string
GetVectorStoreConnectorFileSyncLifecycleStateEnumStringValues Enumerates the set of values in String for VectorStoreConnectorFileSyncLifecycleStateEnum
func GetVectorStoreConnectorFileSyncSummaryTriggerTypeEnumStringValues() []string
GetVectorStoreConnectorFileSyncSummaryTriggerTypeEnumStringValues Enumerates the set of values in String for VectorStoreConnectorFileSyncSummaryTriggerTypeEnum
func GetVectorStoreConnectorFileSyncTriggerTypeEnumStringValues() []string
GetVectorStoreConnectorFileSyncTriggerTypeEnumStringValues Enumerates the set of values in String for VectorStoreConnectorFileSyncTriggerTypeEnum
func GetVectorStoreConnectorIngestionLogsStatusEnumStringValues() []string
GetVectorStoreConnectorIngestionLogsStatusEnumStringValues Enumerates the set of values in String for VectorStoreConnectorIngestionLogsStatusEnum
func GetVectorStoreConnectorLifecycleStateEnumStringValues() []string
GetVectorStoreConnectorLifecycleStateEnumStringValues Enumerates the set of values in String for VectorStoreConnectorLifecycleStateEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddArtifactDetails new artifact details.
type AddArtifactDetails struct {
Artifact CreateArtifactDetails `mandatory:"true" json:"artifact"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m AddArtifactDetails) String() string
func (m *AddArtifactDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AddArtifactDetails) 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
AddArtifactRequest wrapper for the AddArtifact operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/AddArtifact.go.html to see an example of how to use AddArtifactRequest.
type AddArtifactRequest struct {
// Details for the new artifact.
AddArtifactDetails `contributesTo:"body"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
HostedDeploymentId *string `mandatory:"true" contributesTo:"path" name:"hostedDeploymentId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request AddArtifactRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddArtifactRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddArtifactRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddArtifactRequest) String() string
func (request AddArtifactRequest) 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
AddArtifactResponse wrapper for the AddArtifact operation
type AddArtifactResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response AddArtifactResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddArtifactResponse) String() string
ApiKey ApiKeys are resources used to access GenAI models. You must be authorized through an IAM policy to use any API operations. If you're not authorized, contact an administrator who manages OCI resource access. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type ApiKey struct {
// the ApiKey id.
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 compartment OCID to create the apiKey in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The list of keys.
Keys []ApiKeyItem `mandatory:"true" json:"keys"`
// The current state of the API key.
LifecycleState ApiKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An optional description of the Api key.
Description *string `mandatory:"false" json:"description"`
// The date and time the ApiKey was updated, in the format defined by RFC 3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state with detail that can provide actionable information.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ApiKey) String() string
func (m ApiKey) 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
ApiKeyCollection Results of a ApiKey search.
type ApiKeyCollection struct {
// List of apiKeys.
Items []ApiKeySummary `mandatory:"true" json:"items"`
}
func (m ApiKeyCollection) String() string
func (m ApiKeyCollection) 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
ApiKeyItem The ApiKey item.
type ApiKeyItem struct {
// The key name.
KeyName *string `mandatory:"true" json:"keyName"`
// The masked key.
KeyMask *string `mandatory:"true" json:"keyMask"`
// The date and time that the key was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
TimeExpiry *common.SDKTime `mandatory:"true" json:"timeExpiry"`
// The current state of the API key item.
State ApiKeyItemStateEnum `mandatory:"true" json:"state"`
// The key.
Key *string `mandatory:"false" json:"key"`
// The date and time that the key is activated in the format of an RFC3339 datetime string.
TimeActivated *common.SDKTime `mandatory:"false" json:"timeActivated"`
// The date and time that the key is deactivated in the format of an RFC3339 datetime string.
TimeDeactivated *common.SDKTime `mandatory:"false" json:"timeDeactivated"`
// The date and time that the key is revoked in the format of an RFC3339 datetime string.
TimeRevoked *common.SDKTime `mandatory:"false" json:"timeRevoked"`
// The date and time that the key is last used in the format of an RFC3339 datetime string.
TimeLastUsed *common.SDKTime `mandatory:"false" json:"timeLastUsed"`
}
func (m ApiKeyItem) String() string
func (m ApiKeyItem) 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
ApiKeyItemStateEnum Enum with underlying type: string
type ApiKeyItemStateEnum string
Set of constants representing the allowable values for ApiKeyItemStateEnum
const (
ApiKeyItemStateActive ApiKeyItemStateEnum = "ACTIVE"
ApiKeyItemStateInactive ApiKeyItemStateEnum = "INACTIVE"
ApiKeyItemStateRevoked ApiKeyItemStateEnum = "REVOKED"
ApiKeyItemStateExpired ApiKeyItemStateEnum = "EXPIRED"
ApiKeyItemStateDeleted ApiKeyItemStateEnum = "DELETED"
)
func GetApiKeyItemStateEnumValues() []ApiKeyItemStateEnum
GetApiKeyItemStateEnumValues Enumerates the set of values for ApiKeyItemStateEnum
func GetMappingApiKeyItemStateEnum(val string) (ApiKeyItemStateEnum, bool)
GetMappingApiKeyItemStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApiKeyLifecycleStateEnum Enum with underlying type: string
type ApiKeyLifecycleStateEnum string
Set of constants representing the allowable values for ApiKeyLifecycleStateEnum
const (
ApiKeyLifecycleStateCreating ApiKeyLifecycleStateEnum = "CREATING"
ApiKeyLifecycleStateActive ApiKeyLifecycleStateEnum = "ACTIVE"
ApiKeyLifecycleStateInactive ApiKeyLifecycleStateEnum = "INACTIVE"
ApiKeyLifecycleStateUpdating ApiKeyLifecycleStateEnum = "UPDATING"
ApiKeyLifecycleStateDeleting ApiKeyLifecycleStateEnum = "DELETING"
ApiKeyLifecycleStateDeleted ApiKeyLifecycleStateEnum = "DELETED"
ApiKeyLifecycleStateFailed ApiKeyLifecycleStateEnum = "FAILED"
)
func GetApiKeyLifecycleStateEnumValues() []ApiKeyLifecycleStateEnum
GetApiKeyLifecycleStateEnumValues Enumerates the set of values for ApiKeyLifecycleStateEnum
func GetMappingApiKeyLifecycleStateEnum(val string) (ApiKeyLifecycleStateEnum, bool)
GetMappingApiKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApiKeySummary Summary of the API key.
type ApiKeySummary struct {
// the ApiKey id.
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 compartment OCID to create the apiKey in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The list of keys.
Keys []ApiKeyItem `mandatory:"true" json:"keys"`
// The current state of the API key.
// Allowed values are:
// - ACTIVE
// - INACTIVE
// - CREATING
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState ApiKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An optional description of the Api key.
Description *string `mandatory:"false" json:"description"`
// The date and time the ApiKey was updated, in the format defined by RFC 3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state with detail that can provide actionable information.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ApiKeySummary) String() string
func (m ApiKeySummary) 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
Artifact Container/artifact configuration for the deployment.
type Artifact interface {
// if put artifact to a table, the id is needed
GetId() *string
// The date and time the artifact was created.
GetTimeCreated() *common.SDKTime
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
GetHostedDeploymentId() *string
// The current status of the artifact.
GetStatus() ArtifactStatusEnum
}
ArtifactArtifactTypeEnum Enum with underlying type: string
type ArtifactArtifactTypeEnum string
Set of constants representing the allowable values for ArtifactArtifactTypeEnum
const (
ArtifactArtifactTypeSimpleDockerArtifact ArtifactArtifactTypeEnum = "SIMPLE_DOCKER_ARTIFACT"
)
func GetArtifactArtifactTypeEnumValues() []ArtifactArtifactTypeEnum
GetArtifactArtifactTypeEnumValues Enumerates the set of values for ArtifactArtifactTypeEnum
func GetMappingArtifactArtifactTypeEnum(val string) (ArtifactArtifactTypeEnum, bool)
GetMappingArtifactArtifactTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ArtifactStatusEnum Enum with underlying type: string
type ArtifactStatusEnum string
Set of constants representing the allowable values for ArtifactStatusEnum
const (
ArtifactStatusActive ArtifactStatusEnum = "ACTIVE"
ArtifactStatusInactive ArtifactStatusEnum = "INACTIVE"
ArtifactStatusUpdating ArtifactStatusEnum = "UPDATING"
)
func GetArtifactStatusEnumValues() []ArtifactStatusEnum
GetArtifactStatusEnumValues Enumerates the set of values for ArtifactStatusEnum
func GetMappingArtifactStatusEnum(val string) (ArtifactStatusEnum, bool)
GetMappingArtifactStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CancelVectorStoreConnectorFileSyncRequest wrapper for the CancelVectorStoreConnectorFileSync operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CancelVectorStoreConnectorFileSync.go.html to see an example of how to use CancelVectorStoreConnectorFileSyncRequest.
type CancelVectorStoreConnectorFileSyncRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync.
VectorStoreConnectorFileSyncId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorFileSyncId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelVectorStoreConnectorFileSyncRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelVectorStoreConnectorFileSyncRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelVectorStoreConnectorFileSyncRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelVectorStoreConnectorFileSyncRequest) String() string
func (request CancelVectorStoreConnectorFileSyncRequest) 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
CancelVectorStoreConnectorFileSyncResponse wrapper for the CancelVectorStoreConnectorFileSync operation
type CancelVectorStoreConnectorFileSyncResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelVectorStoreConnectorFileSyncResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelVectorStoreConnectorFileSyncResponse) String() string
ChangeApiKeyCompartmentDetails The details to move an APIKey to another compartment.
type ChangeApiKeyCompartmentDetails struct {
// The OCID of the compartment to move the APIKey to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeApiKeyCompartmentDetails) String() string
func (m ChangeApiKeyCompartmentDetails) 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
ChangeApiKeyCompartmentRequest wrapper for the ChangeApiKeyCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeApiKeyCompartment.go.html to see an example of how to use ChangeApiKeyCompartmentRequest.
type ChangeApiKeyCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`
// The API key information to be updated.
ChangeApiKeyCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeApiKeyCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeApiKeyCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeApiKeyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeApiKeyCompartmentRequest) String() string
func (request ChangeApiKeyCompartmentRequest) 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
ChangeApiKeyCompartmentResponse wrapper for the ChangeApiKeyCompartment operation
type ChangeApiKeyCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeApiKeyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApiKeyCompartmentResponse) String() string
ChangeDedicatedAiClusterCompartmentDetails The details to move a dedicated AI cluster to another compartment.
type ChangeDedicatedAiClusterCompartmentDetails struct {
// The OCID of the compartment to move the dedicated AI cluster to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDedicatedAiClusterCompartmentDetails) String() string
func (m ChangeDedicatedAiClusterCompartmentDetails) 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
ChangeDedicatedAiClusterCompartmentRequest wrapper for the ChangeDedicatedAiClusterCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeDedicatedAiClusterCompartment.go.html to see an example of how to use ChangeDedicatedAiClusterCompartmentRequest.
type ChangeDedicatedAiClusterCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
DedicatedAiClusterId *string `mandatory:"true" contributesTo:"path" name:"dedicatedAiClusterId"`
// The information to be updated.
ChangeDedicatedAiClusterCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeDedicatedAiClusterCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDedicatedAiClusterCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDedicatedAiClusterCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDedicatedAiClusterCompartmentRequest) String() string
func (request ChangeDedicatedAiClusterCompartmentRequest) 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
ChangeDedicatedAiClusterCompartmentResponse wrapper for the ChangeDedicatedAiClusterCompartment operation
type ChangeDedicatedAiClusterCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeDedicatedAiClusterCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDedicatedAiClusterCompartmentResponse) String() string
ChangeEndpointCompartmentDetails The details to move an endpoint to another compartment.
type ChangeEndpointCompartmentDetails struct {
// The OCID of the compartment to move the endpoint to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeEndpointCompartmentDetails) String() string
func (m ChangeEndpointCompartmentDetails) 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
ChangeEndpointCompartmentRequest wrapper for the ChangeEndpointCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeEndpointCompartment.go.html to see an example of how to use ChangeEndpointCompartmentRequest.
type ChangeEndpointCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// The endpoint information to be updated.
ChangeEndpointCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeEndpointCompartmentRequest) String() string
func (request ChangeEndpointCompartmentRequest) 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
ChangeEndpointCompartmentResponse wrapper for the ChangeEndpointCompartment operation
type ChangeEndpointCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeEndpointCompartmentResponse) String() string
ChangeGenerativeAiPrivateEndpointCompartmentDetails The details required to change a private endpoint compartment.
type ChangeGenerativeAiPrivateEndpointCompartmentDetails struct {
// The OCID of the target compartment where the private endpoint is moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeGenerativeAiPrivateEndpointCompartmentDetails) String() string
func (m ChangeGenerativeAiPrivateEndpointCompartmentDetails) 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
ChangeGenerativeAiPrivateEndpointCompartmentRequest wrapper for the ChangeGenerativeAiPrivateEndpointCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeGenerativeAiPrivateEndpointCompartment.go.html to see an example of how to use ChangeGenerativeAiPrivateEndpointCompartmentRequest.
type ChangeGenerativeAiPrivateEndpointCompartmentRequest struct {
// The unique id for a Generative AI private endpoint.
GenerativeAiPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"generativeAiPrivateEndpointId"`
// Details for changing a Generative AI private endpoint's compartment.
ChangeGenerativeAiPrivateEndpointCompartmentDetails `contributesTo:"body"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeGenerativeAiPrivateEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeGenerativeAiPrivateEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeGenerativeAiPrivateEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeGenerativeAiPrivateEndpointCompartmentRequest) String() string
func (request ChangeGenerativeAiPrivateEndpointCompartmentRequest) 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
ChangeGenerativeAiPrivateEndpointCompartmentResponse wrapper for the ChangeGenerativeAiPrivateEndpointCompartment operation
type ChangeGenerativeAiPrivateEndpointCompartmentResponse 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"`
// The OCID (https://docs.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"`
}
func (response ChangeGenerativeAiPrivateEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeGenerativeAiPrivateEndpointCompartmentResponse) String() string
ChangeGenerativeAiProjectCompartmentDetails The details to move a GenerativeAiProject to another compartment.
type ChangeGenerativeAiProjectCompartmentDetails struct {
// The OCID of the compartment to move the GenerativeAiProject to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeGenerativeAiProjectCompartmentDetails) String() string
func (m ChangeGenerativeAiProjectCompartmentDetails) 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
ChangeGenerativeAiProjectCompartmentRequest wrapper for the ChangeGenerativeAiProjectCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeGenerativeAiProjectCompartment.go.html to see an example of how to use ChangeGenerativeAiProjectCompartmentRequest.
type ChangeGenerativeAiProjectCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject.
GenerativeAiProjectId *string `mandatory:"true" contributesTo:"path" name:"generativeAiProjectId"`
// The generativeAiProject information to be updated.
ChangeGenerativeAiProjectCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeGenerativeAiProjectCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeGenerativeAiProjectCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeGenerativeAiProjectCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeGenerativeAiProjectCompartmentRequest) String() string
func (request ChangeGenerativeAiProjectCompartmentRequest) 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
ChangeGenerativeAiProjectCompartmentResponse wrapper for the ChangeGenerativeAiProjectCompartment operation
type ChangeGenerativeAiProjectCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeGenerativeAiProjectCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeGenerativeAiProjectCompartmentResponse) String() string
ChangeHostedApplicationCompartmentDetails The details to move a hosted application to another compartment.
type ChangeHostedApplicationCompartmentDetails struct {
// The OCID of the compartment to move the hosted application to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeHostedApplicationCompartmentDetails) String() string
func (m ChangeHostedApplicationCompartmentDetails) 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
ChangeHostedApplicationCompartmentRequest wrapper for the ChangeHostedApplicationCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeHostedApplicationCompartment.go.html to see an example of how to use ChangeHostedApplicationCompartmentRequest.
type ChangeHostedApplicationCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
HostedApplicationId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationId"`
// The information to be updated.
ChangeHostedApplicationCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeHostedApplicationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeHostedApplicationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeHostedApplicationCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeHostedApplicationCompartmentRequest) String() string
func (request ChangeHostedApplicationCompartmentRequest) 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
ChangeHostedApplicationCompartmentResponse wrapper for the ChangeHostedApplicationCompartment operation
type ChangeHostedApplicationCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeHostedApplicationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeHostedApplicationCompartmentResponse) String() string
ChangeHostedApplicationStorageCompartmentDetails The details to move a hosted application storage to another compartment.
type ChangeHostedApplicationStorageCompartmentDetails struct {
// The OCID of the compartment to move the hosted application storage to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeHostedApplicationStorageCompartmentDetails) String() string
func (m ChangeHostedApplicationStorageCompartmentDetails) 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
ChangeHostedApplicationStorageCompartmentRequest wrapper for the ChangeHostedApplicationStorageCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeHostedApplicationStorageCompartment.go.html to see an example of how to use ChangeHostedApplicationStorageCompartmentRequest.
type ChangeHostedApplicationStorageCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage.
HostedApplicationStorageId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationStorageId"`
// The information to be updated.
ChangeHostedApplicationStorageCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeHostedApplicationStorageCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeHostedApplicationStorageCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeHostedApplicationStorageCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeHostedApplicationStorageCompartmentRequest) String() string
func (request ChangeHostedApplicationStorageCompartmentRequest) 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
ChangeHostedApplicationStorageCompartmentResponse wrapper for the ChangeHostedApplicationStorageCompartment operation
type ChangeHostedApplicationStorageCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeHostedApplicationStorageCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeHostedApplicationStorageCompartmentResponse) String() string
ChangeImportedModelCompartmentDetails The details to move an imported model to another compartment.
type ChangeImportedModelCompartmentDetails struct {
// The destination compartment OCID
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeImportedModelCompartmentDetails) String() string
func (m ChangeImportedModelCompartmentDetails) 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
ChangeImportedModelCompartmentRequest wrapper for the ChangeImportedModelCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeImportedModelCompartment.go.html to see an example of how to use ChangeImportedModelCompartmentRequest.
type ChangeImportedModelCompartmentRequest struct {
// The importedModel OCID
ImportedModelId *string `mandatory:"true" contributesTo:"path" name:"importedModelId"`
// The information to be updated.
ChangeImportedModelCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeImportedModelCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeImportedModelCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeImportedModelCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeImportedModelCompartmentRequest) String() string
func (request ChangeImportedModelCompartmentRequest) 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
ChangeImportedModelCompartmentResponse wrapper for the ChangeImportedModelCompartment operation
type ChangeImportedModelCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeImportedModelCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeImportedModelCompartmentResponse) String() string
ChangeModelCompartmentDetails The details to move a custom model to another compartment.
type ChangeModelCompartmentDetails struct {
// The compartment OCID to create the model in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeModelCompartmentDetails) String() string
func (m ChangeModelCompartmentDetails) 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
ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartmentRequest.
type ChangeModelCompartmentRequest struct {
// The model OCID
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// The information to be updated.
ChangeModelCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeModelCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeModelCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeModelCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeModelCompartmentRequest) String() string
func (request ChangeModelCompartmentRequest) 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
ChangeModelCompartmentResponse wrapper for the ChangeModelCompartment operation
type ChangeModelCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeModelCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeModelCompartmentResponse) String() string
ChangeSemanticStoreCompartmentDetails The details to move a SemanticStore to another compartment.
type ChangeSemanticStoreCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the SemanticStore to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSemanticStoreCompartmentDetails) String() string
func (m ChangeSemanticStoreCompartmentDetails) 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
ChangeSemanticStoreCompartmentRequest wrapper for the ChangeSemanticStoreCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeSemanticStoreCompartment.go.html to see an example of how to use ChangeSemanticStoreCompartmentRequest.
type ChangeSemanticStoreCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore.
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// The SemanticStore information to be updated.
ChangeSemanticStoreCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeSemanticStoreCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeSemanticStoreCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSemanticStoreCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSemanticStoreCompartmentRequest) String() string
func (request ChangeSemanticStoreCompartmentRequest) 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
ChangeSemanticStoreCompartmentResponse wrapper for the ChangeSemanticStoreCompartment operation
type ChangeSemanticStoreCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeSemanticStoreCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSemanticStoreCompartmentResponse) String() string
ChatModelMetrics The chat model metrics of the fine-tuning process.
type ChatModelMetrics struct {
// Fine-tuned model accuracy.
FinalAccuracy *float64 `mandatory:"false" json:"finalAccuracy"`
// Fine-tuned model loss.
FinalLoss *float64 `mandatory:"false" json:"finalLoss"`
}
func (m ChatModelMetrics) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ChatModelMetrics) String() string
func (m ChatModelMetrics) 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
CondenserConfig Configuration for condensing conversation content.
type CondenserConfig struct {
LlmSelection LlmSelection `mandatory:"true" json:"llmSelection"`
}
func (m CondenserConfig) GetLlmSelection() LlmSelection
GetLlmSelection returns LlmSelection
func (m CondenserConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CondenserConfig) String() string
func (m *CondenserConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CondenserConfig) 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
ConnectorConfiguration Datasource configuration for the connector.
type ConnectorConfiguration interface {
}
ConnectorConfigurationTypeEnum Enum with underlying type: string
type ConnectorConfigurationTypeEnum string
Set of constants representing the allowable values for ConnectorConfigurationTypeEnum
const (
ConnectorConfigurationTypeObjectStorageFiles ConnectorConfigurationTypeEnum = "OBJECT_STORAGE_FILES"
)
func GetConnectorConfigurationTypeEnumValues() []ConnectorConfigurationTypeEnum
GetConnectorConfigurationTypeEnumValues Enumerates the set of values for ConnectorConfigurationTypeEnum
func GetMappingConnectorConfigurationTypeEnum(val string) (ConnectorConfigurationTypeEnum, bool)
GetMappingConnectorConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ContentModerationConfig The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses.
type ContentModerationConfig struct {
// Whether to enable the content moderation feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// Enum for the modes of operation for inference protection.
Mode ContentModerationConfigModeEnum `mandatory:"false" json:"mode,omitempty"`
// The OCID of the model used for the feature.
ModelId *string `mandatory:"false" json:"modelId"`
}
func (m ContentModerationConfig) String() string
func (m ContentModerationConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ContentModerationConfigModeEnum Enum with underlying type: string
type ContentModerationConfigModeEnum string
Set of constants representing the allowable values for ContentModerationConfigModeEnum
const (
ContentModerationConfigModeInform ContentModerationConfigModeEnum = "INFORM"
ContentModerationConfigModeBlock ContentModerationConfigModeEnum = "BLOCK"
)
func GetContentModerationConfigModeEnumValues() []ContentModerationConfigModeEnum
GetContentModerationConfigModeEnumValues Enumerates the set of values for ContentModerationConfigModeEnum
func GetMappingContentModerationConfigModeEnum(val string) (ContentModerationConfigModeEnum, bool)
GetMappingContentModerationConfigModeEnum performs case Insensitive comparison on enum value and return the desired enum
ConversationConfig Holds configuration related to conversation retention
type ConversationConfig struct {
// Retention period (in hours) for responses. The TTL starts from the time the response was created.
ResponsesRetentionInHours *int `mandatory:"false" json:"responsesRetentionInHours"`
// Retention period (in hours) for conversations. The TTL starts from the time the conversation was last updated.
ConversationsRetentionInHours *int `mandatory:"false" json:"conversationsRetentionInHours"`
}
func (m ConversationConfig) String() string
func (m ConversationConfig) 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
CreateApiKeyDetails The data to create an API key.
type CreateApiKeyDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The compartment OCID to create the apiKey in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The list of key details for creation.
KeyDetails []KeyDetails `mandatory:"true" json:"keyDetails"`
// An optional description of the Api key.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateApiKeyDetails) String() string
func (m CreateApiKeyDetails) 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
CreateApiKeyRequest wrapper for the CreateApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateApiKey.go.html to see an example of how to use CreateApiKeyRequest.
type CreateApiKeyRequest struct {
// Details for the new apiKey.
CreateApiKeyDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateApiKeyRequest) String() string
func (request CreateApiKeyRequest) 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
CreateApiKeyResponse wrapper for the CreateApiKey operation
type CreateApiKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiKey instance
ApiKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApiKeyResponse) String() string
CreateArtifactDetails Artifact configuration input for the deployment.
type CreateArtifactDetails interface {
}
CreateArtifactDetailsArtifactTypeEnum Enum with underlying type: string
type CreateArtifactDetailsArtifactTypeEnum string
Set of constants representing the allowable values for CreateArtifactDetailsArtifactTypeEnum
const (
CreateArtifactDetailsArtifactTypeSimpleDockerArtifact CreateArtifactDetailsArtifactTypeEnum = "SIMPLE_DOCKER_ARTIFACT"
)
func GetCreateArtifactDetailsArtifactTypeEnumValues() []CreateArtifactDetailsArtifactTypeEnum
GetCreateArtifactDetailsArtifactTypeEnumValues Enumerates the set of values for CreateArtifactDetailsArtifactTypeEnum
func GetMappingCreateArtifactDetailsArtifactTypeEnum(val string) (CreateArtifactDetailsArtifactTypeEnum, bool)
GetMappingCreateArtifactDetailsArtifactTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDataSourceDatabaseToolsConnectionDetails Defines the OCI Database Tools Connection data source that the semantic model connects to.
type CreateDataSourceDatabaseToolsConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI Database Tools Connection for querying.
QueryingConnectionId *string `mandatory:"true" json:"queryingConnectionId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI Database Tools Connection for enrichment.
EnrichmentConnectionId *string `mandatory:"true" json:"enrichmentConnectionId"`
}
func (m CreateDataSourceDatabaseToolsConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDataSourceDatabaseToolsConnectionDetails) String() string
func (m CreateDataSourceDatabaseToolsConnectionDetails) 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
CreateDataSourceDetails Defines the data source that the semantic model connects to.
type CreateDataSourceDetails interface {
}
CreateDataSourceDetailsConnectionTypeEnum Enum with underlying type: string
type CreateDataSourceDetailsConnectionTypeEnum string
Set of constants representing the allowable values for CreateDataSourceDetailsConnectionTypeEnum
const (
CreateDataSourceDetailsConnectionTypeDatabaseToolsConnection CreateDataSourceDetailsConnectionTypeEnum = "DATABASE_TOOLS_CONNECTION"
)
func GetCreateDataSourceDetailsConnectionTypeEnumValues() []CreateDataSourceDetailsConnectionTypeEnum
GetCreateDataSourceDetailsConnectionTypeEnumValues Enumerates the set of values for CreateDataSourceDetailsConnectionTypeEnum
func GetMappingCreateDataSourceDetailsConnectionTypeEnum(val string) (CreateDataSourceDetailsConnectionTypeEnum, bool)
GetMappingCreateDataSourceDetailsConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDedicatedAiClusterDetails The data to create a dedicated AI cluster.
type CreateDedicatedAiClusterDetails struct {
// The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
// Allowed values are:
// - HOSTING
// - FINE_TUNING
Type DedicatedAiClusterTypeEnum `mandatory:"true" json:"type"`
// The compartment OCID to create the dedicated AI cluster in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The number of dedicated units in this AI cluster.
UnitCount *int `mandatory:"true" json:"unitCount"`
// The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
// Allowed values are:
// - LARGE_COHERE
// - LARGE_COHERE_V2
// - SMALL_COHERE
// - SMALL_COHERE_V2
// - SMALL_COHERE_4
// - EMBED_COHERE
// - LLAMA2_70
// - LARGE_GENERIC
// - LARGE_COHERE_V2_2
// - LARGE_GENERIC_4
// - SMALL_GENERIC_V2
// - LARGE_GENERIC_2
// - LARGE_GENERIC_V3
// - LARGE_COHERE_V3
// - RERANK_COHERE
// - SMALL_GENERIC_V1
// - MEDIUM_GENERIC_V1
// - LARGE_GENERIC_V1
// - A10_X1
// - A10_X2
// - A10_X4
// - A100_40G_X1
// - A100_40G_X2
// - A100_40G_X4
// - A100_40G_X8
// - A100_80G_X1
// - A100_80G_X2
// - A100_80G_X4
// - A100_80G_X8
// - H100_X1
// - H100_X2
// - H100_X4
// - H100_X8
// - H200_X1
// - H200_X2
// - H200_X4
// - H200_X8
// The following shapes can only be used to deploy imported models:
// - A10_X1, A10_X2, A10_X4
// - A100_40G_X1, A100_40G_X2, A100_40G_X4, A100_40G_X8
// - A100_80G_X1, A100_80G_X2, A100_80G_X4, A100_80G_X8
// - H100_X1, H100_X2, H100_X4, H100_X8
// - H200_X1, H200_X2, H200_X4, H200_X8
// - OAI_A10_X2
// - OAI_H100_X1
// - OAI_H100_X2
// - OAI_H200_X1
// - OAI_A100_80G_X1
// - OAI_A100_80G_X2
// - OAI_A100_40G_X1
// - OAI_A100_40G_X4
UnitShape DedicatedAiClusterUnitShapeEnum `mandatory:"true" json:"unitShape"`
// 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 dedicated AI cluster.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDedicatedAiClusterDetails) String() string
func (m CreateDedicatedAiClusterDetails) 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
CreateDedicatedAiClusterRequest wrapper for the CreateDedicatedAiCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateDedicatedAiCluster.go.html to see an example of how to use CreateDedicatedAiClusterRequest.
type CreateDedicatedAiClusterRequest struct {
// Details for the new dedicated AI cluster.
CreateDedicatedAiClusterDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDedicatedAiClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDedicatedAiClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDedicatedAiClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDedicatedAiClusterRequest) String() string
func (request CreateDedicatedAiClusterRequest) 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
CreateDedicatedAiClusterResponse wrapper for the CreateDedicatedAiCluster operation
type CreateDedicatedAiClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DedicatedAiCluster instance
DedicatedAiCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.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"`
// Provides deprecation details for models, included only when a model is deprecated.
ModelDeprecationInfo *string `presentIn:"header" name:"model-deprecation-info"`
}
func (response CreateDedicatedAiClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDedicatedAiClusterResponse) String() string
CreateEndpointDetails The data to create an endpoint.
type CreateEndpointDetails struct {
// The compartment OCID to create the endpoint in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the model that's used to create this endpoint.
ModelId *string `mandatory:"true" json:"modelId"`
// The OCID of the dedicated AI cluster on which a model will be deployed to.
DedicatedAiClusterId *string `mandatory:"true" json:"dedicatedAiClusterId"`
// 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"`
// The OCID of the Generative AI private endpoint to which this endpoint is attached to.
GenerativeAiPrivateEndpointId *string `mandatory:"false" json:"generativeAiPrivateEndpointId"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
PromptInjectionConfig *PromptInjectionConfig `mandatory:"false" json:"promptInjectionConfig"`
PiiDetectionConfig *PiiDetectionConfig `mandatory:"false" json:"piiDetectionConfig"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateEndpointDetails) String() string
func (m CreateEndpointDetails) 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
CreateEndpointRequest wrapper for the CreateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateEndpoint.go.html to see an example of how to use CreateEndpointRequest.
type CreateEndpointRequest struct {
// Details for the new endpoint.
CreateEndpointDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEndpointRequest) String() string
func (request CreateEndpointRequest) 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
CreateEndpointResponse wrapper for the CreateEndpoint operation
type CreateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The Endpoint instance
Endpoint `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.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"`
// Provides deprecation details for models, included only when a model is deprecated.
ModelDeprecationInfo *string `presentIn:"header" name:"model-deprecation-info"`
}
func (response CreateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEndpointResponse) String() string
CreateGenerativeAiPrivateEndpointDetails The details required to create a Generative AI private endpoint.
type CreateGenerativeAiPrivateEndpointDetails struct {
// The OCID of the compartment where the private endpoint is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the customer's subnet where the private endpoint VNIC will reside.
SubnetId *string `mandatory:"true" json:"subnetId"`
// dnsPrefix of the private endpoint FQDN.
DnsPrefix *string `mandatory:"true" json:"dnsPrefix"`
// A description of this private endpoint.
Description *string `mandatory:"false" json:"description"`
// A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Flag that allows access to on-demand models using this private endpoint.
IsAllowOnDemand *bool `mandatory:"false" json:"isAllowOnDemand"`
// The resource type that Generative AI private endpoint can be used for.
ResourceType GenerativeAiPrivateEndpointResourceTypeEnum `mandatory:"false" json:"resourceType,omitempty"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m CreateGenerativeAiPrivateEndpointDetails) String() string
func (m CreateGenerativeAiPrivateEndpointDetails) 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
CreateGenerativeAiPrivateEndpointRequest wrapper for the CreateGenerativeAiPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateGenerativeAiPrivateEndpoint.go.html to see an example of how to use CreateGenerativeAiPrivateEndpointRequest.
type CreateGenerativeAiPrivateEndpointRequest struct {
// The parameters required to create a private endpoint.
CreateGenerativeAiPrivateEndpointDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateGenerativeAiPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGenerativeAiPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGenerativeAiPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGenerativeAiPrivateEndpointRequest) String() string
func (request CreateGenerativeAiPrivateEndpointRequest) 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
CreateGenerativeAiPrivateEndpointResponse wrapper for the CreateGenerativeAiPrivateEndpoint operation
type CreateGenerativeAiPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerativeAiPrivateEndpoint instance
GenerativeAiPrivateEndpoint `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"`
// The OCID (https://docs.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"`
}
func (response CreateGenerativeAiPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGenerativeAiPrivateEndpointResponse) String() string
CreateGenerativeAiProjectDetails The data to create a GenerativeAiProject.
type CreateGenerativeAiProjectDetails struct {
// Owning compartment OCID for a GenerativeAiProject.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// An optional description of the GenerativeAiProject.
Description *string `mandatory:"false" json:"description"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
ConversationConfig *ConversationConfig `mandatory:"false" json:"conversationConfig"`
LongTermMemoryConfig *LongTermMemoryConfig `mandatory:"false" json:"longTermMemoryConfig"`
ShortTermMemoryOptimizationConfig *ShortTermMemoryOptimizationConfig `mandatory:"false" json:"shortTermMemoryOptimizationConfig"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateGenerativeAiProjectDetails) String() string
func (m CreateGenerativeAiProjectDetails) 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
CreateGenerativeAiProjectRequest wrapper for the CreateGenerativeAiProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateGenerativeAiProject.go.html to see an example of how to use CreateGenerativeAiProjectRequest.
type CreateGenerativeAiProjectRequest struct {
// Details for the new generativeAiProject.
CreateGenerativeAiProjectDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateGenerativeAiProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGenerativeAiProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGenerativeAiProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGenerativeAiProjectRequest) String() string
func (request CreateGenerativeAiProjectRequest) 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
CreateGenerativeAiProjectResponse wrapper for the CreateGenerativeAiProject operation
type CreateGenerativeAiProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerativeAiProject instance
GenerativeAiProject `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateGenerativeAiProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGenerativeAiProjectResponse) String() string
CreateHostedApplicationDetails The details required to create a hosted application.
type CreateHostedApplicationDetails struct {
// The user-friendly display name for the Hosted Application.
// Does not need to be unique and can be updated after creation.
DisplayName *string `mandatory:"true" json:"displayName"`
// The compartment OCID for the Hosted Application.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The description for the Hosted Application.
Description *string `mandatory:"false" json:"description"`
ScalingConfig *ScalingConfig `mandatory:"false" json:"scalingConfig"`
InboundAuthConfig *InboundAuthConfig `mandatory:"false" json:"inboundAuthConfig"`
NetworkingConfig *NetworkingConfig `mandatory:"false" json:"networkingConfig"`
// The list of storage configuration for the Hosted Application.
// Defines a list of service-managed storage back-ends.
StorageConfigs []StorageConfig `mandatory:"false" json:"storageConfigs"`
// The list of environment variables for the Hosted Application.
// Defines a list of environment variables injected at runtime.
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateHostedApplicationDetails) String() string
func (m CreateHostedApplicationDetails) 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
CreateHostedApplicationRequest wrapper for the CreateHostedApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateHostedApplication.go.html to see an example of how to use CreateHostedApplicationRequest.
type CreateHostedApplicationRequest struct {
// Details for the new hosted application.
CreateHostedApplicationDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateHostedApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHostedApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHostedApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHostedApplicationRequest) String() string
func (request CreateHostedApplicationRequest) 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
CreateHostedApplicationResponse wrapper for the CreateHostedApplication operation
type CreateHostedApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedApplication instance
HostedApplication `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateHostedApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHostedApplicationResponse) String() string
CreateHostedApplicationStorageDetails The data to create a hosted application storage.
type CreateHostedApplicationStorageDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// The compartment OCID to create the hosted application in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// type like Cache, Postgresql and ADB.
StorageType HostedApplicationStorageStorageTypeEnum `mandatory:"true" json:"storageType"`
// An optional description of the hosted application.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateHostedApplicationStorageDetails) String() string
func (m CreateHostedApplicationStorageDetails) 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
CreateHostedApplicationStorageRequest wrapper for the CreateHostedApplicationStorage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateHostedApplicationStorage.go.html to see an example of how to use CreateHostedApplicationStorageRequest.
type CreateHostedApplicationStorageRequest struct {
// Details for the new hosted application storage.
CreateHostedApplicationStorageDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateHostedApplicationStorageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHostedApplicationStorageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHostedApplicationStorageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHostedApplicationStorageRequest) String() string
func (request CreateHostedApplicationStorageRequest) 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
CreateHostedApplicationStorageResponse wrapper for the CreateHostedApplicationStorage operation
type CreateHostedApplicationStorageResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedApplicationStorage instance
HostedApplicationStorage `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateHostedApplicationStorageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHostedApplicationStorageResponse) String() string
CreateHostedDeploymentDetails The data to create a hosted deployment.
type CreateHostedDeploymentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
HostedApplicationId *string `mandatory:"true" json:"hostedApplicationId"`
ActiveArtifact Artifact `mandatory:"true" json:"activeArtifact"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// The compartment OCID to create the hosted deployment in.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateHostedDeploymentDetails) String() string
func (m *CreateHostedDeploymentDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateHostedDeploymentDetails) 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
CreateHostedDeploymentRequest wrapper for the CreateHostedDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateHostedDeployment.go.html to see an example of how to use CreateHostedDeploymentRequest.
type CreateHostedDeploymentRequest struct {
// Details for the new hosted deployment.
CreateHostedDeploymentDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateHostedDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHostedDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHostedDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHostedDeploymentRequest) String() string
func (request CreateHostedDeploymentRequest) 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
CreateHostedDeploymentResponse wrapper for the CreateHostedDeployment operation
type CreateHostedDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedDeployment instance
HostedDeployment `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateHostedDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHostedDeploymentResponse) String() string
CreateImportedModelDetails The data to import a model.
type CreateImportedModelDetails struct {
// The compartment OCID from which the model is imported.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
DataSource ModelDataSource `mandatory:"true" json:"dataSource"`
// A user-friendly name for the imported model.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the imported model.
Description *string `mandatory:"false" json:"description"`
// The provider of the imported model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the imported model.
Version *string `mandatory:"false" json:"version"`
// Specifies the intended use or supported capabilities of the imported model.
Capabilities []ImportedModelCapabilityEnum `mandatory:"false" json:"capabilities,omitempty"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateImportedModelDetails) String() string
func (m *CreateImportedModelDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateImportedModelDetails) 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
CreateImportedModelRequest wrapper for the CreateImportedModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateImportedModel.go.html to see an example of how to use CreateImportedModelRequest.
type CreateImportedModelRequest struct {
// Details for importing a model.
CreateImportedModelDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateImportedModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateImportedModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateImportedModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateImportedModelRequest) String() string
func (request CreateImportedModelRequest) 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
CreateImportedModelResponse wrapper for the CreateImportedModel operation
type CreateImportedModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportedModel instance
ImportedModel `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateImportedModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateImportedModelResponse) String() string
CreateModelDetails The data to create a custom model.
type CreateModelDetails struct {
// The compartment OCID for fine-tuned models. For pretrained models, this value is null.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the base model that's used for fine-tuning.
BaseModelId *string `mandatory:"true" json:"baseModelId"`
FineTuneDetails *FineTuneDetails `mandatory:"true" json:"fineTuneDetails"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The provider of the model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the model.
Version *string `mandatory:"false" json:"version"`
// An optional description of the model.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateModelDetails) String() string
func (m CreateModelDetails) 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
CreateModelRequest wrapper for the CreateModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateModel.go.html to see an example of how to use CreateModelRequest.
type CreateModelRequest struct {
// Details for the new model.
CreateModelDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateModelRequest) String() string
func (request CreateModelRequest) 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
CreateModelResponse wrapper for the CreateModel operation
type CreateModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.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"`
// Provides deprecation details for models, included only when a model is deprecated.
ModelDeprecationInfo *string `presentIn:"header" name:"model-deprecation-info"`
}
func (response CreateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateModelResponse) String() string
CreateSchemasDatabaseToolsConnectionDetails Array of database schemas or database objects included in the enrichment pipeline for data sources connected via an OCI Database Tools connection.
type CreateSchemasDatabaseToolsConnectionDetails struct {
// Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: {
// "schemas": [
// { "name": "HR" }
// ]
// } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
Schemas []SchemaItem `mandatory:"true" json:"schemas"`
}
func (m CreateSchemasDatabaseToolsConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSchemasDatabaseToolsConnectionDetails) String() string
func (m CreateSchemasDatabaseToolsConnectionDetails) 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
CreateSchemasDetails Array of database schemas or other database objects to include in enrichment pipeline.
type CreateSchemasDetails interface {
}
CreateSchemasDetailsConnectionTypeEnum Enum with underlying type: string
type CreateSchemasDetailsConnectionTypeEnum string
Set of constants representing the allowable values for CreateSchemasDetailsConnectionTypeEnum
const (
CreateSchemasDetailsConnectionTypeDatabaseToolsConnection CreateSchemasDetailsConnectionTypeEnum = "DATABASE_TOOLS_CONNECTION"
)
func GetCreateSchemasDetailsConnectionTypeEnumValues() []CreateSchemasDetailsConnectionTypeEnum
GetCreateSchemasDetailsConnectionTypeEnumValues Enumerates the set of values for CreateSchemasDetailsConnectionTypeEnum
func GetMappingCreateSchemasDetailsConnectionTypeEnum(val string) (CreateSchemasDetailsConnectionTypeEnum, bool)
GetMappingCreateSchemasDetailsConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateSemanticStoreDetails The data to create a SemanticStore.
type CreateSemanticStoreDetails struct {
// Owning compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for a SemanticStore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name.
DisplayName *string `mandatory:"true" json:"displayName"`
DataSource CreateDataSourceDetails `mandatory:"true" json:"dataSource"`
Schemas CreateSchemasDetails `mandatory:"true" json:"schemas"`
// An optional description of the SemanticStore.
Description *string `mandatory:"false" json:"description"`
RefreshSchedule RefreshScheduleDetails `mandatory:"false" json:"refreshSchedule"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateSemanticStoreDetails) String() string
func (m *CreateSemanticStoreDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateSemanticStoreDetails) 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
CreateSemanticStoreRequest wrapper for the CreateSemanticStore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateSemanticStore.go.html to see an example of how to use CreateSemanticStoreRequest.
type CreateSemanticStoreRequest struct {
// Details for the new SemanticStore.
CreateSemanticStoreDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSemanticStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSemanticStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSemanticStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSemanticStoreRequest) String() string
func (request CreateSemanticStoreRequest) 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
CreateSemanticStoreResponse wrapper for the CreateSemanticStore operation
type CreateSemanticStoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The SemanticStore instance
SemanticStore `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"`
// The OCID (https://docs.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"`
}
func (response CreateSemanticStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSemanticStoreResponse) String() string
CreateSingleDockerArtifactDetails The representation of CreateSingleDockerArtifactDetails
type CreateSingleDockerArtifactDetails struct {
// image url.
ContainerUri *string `mandatory:"false" json:"containerUri"`
// image tag.
Tag *string `mandatory:"false" json:"tag"`
}
func (m CreateSingleDockerArtifactDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSingleDockerArtifactDetails) String() string
func (m CreateSingleDockerArtifactDetails) 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
CreateVectorStoreConnectorDetails The data to create a VectorStoreConnector.
type CreateVectorStoreConnectorDetails struct {
// Owning compartment OCID for a ConversationStore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// An OCID that identifies the Vector Store to which this connector is connected.
VectorStoreId *string `mandatory:"true" json:"vectorStoreId"`
// A user-friendly name for the VectorStoreConnector.
DisplayName *string `mandatory:"true" json:"displayName"`
Configuration ConnectorConfiguration `mandatory:"true" json:"configuration"`
// An optional description of the VectorStoreConnector.
Description *string `mandatory:"false" json:"description"`
ScheduleConfig ScheduleConfig `mandatory:"false" json:"scheduleConfig"`
// An optional customer Encryption Key stored in OCI Vault that can be used to decrypt the data downloaded from the data source.
VaultSecretId *string `mandatory:"false" json:"vaultSecretId"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateVectorStoreConnectorDetails) String() string
func (m *CreateVectorStoreConnectorDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateVectorStoreConnectorDetails) 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
CreateVectorStoreConnectorFileSyncDetails The data to create a VectorStoreConnectorFileSync.
type CreateVectorStoreConnectorFileSyncDetails struct {
// An OCID that identifies the VectorStoreConnector under which this FileSync operation is created.
VectorStoreConnectorId *string `mandatory:"true" json:"vectorStoreConnectorId"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateVectorStoreConnectorFileSyncDetails) String() string
func (m CreateVectorStoreConnectorFileSyncDetails) 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
CreateVectorStoreConnectorFileSyncRequest wrapper for the CreateVectorStoreConnectorFileSync operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateVectorStoreConnectorFileSync.go.html to see an example of how to use CreateVectorStoreConnectorFileSyncRequest.
type CreateVectorStoreConnectorFileSyncRequest struct {
// Details for the new vectorStoreConnectorFileSync.
CreateVectorStoreConnectorFileSyncDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateVectorStoreConnectorFileSyncRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVectorStoreConnectorFileSyncRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVectorStoreConnectorFileSyncRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVectorStoreConnectorFileSyncRequest) String() string
func (request CreateVectorStoreConnectorFileSyncRequest) 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
CreateVectorStoreConnectorFileSyncResponse wrapper for the CreateVectorStoreConnectorFileSync operation
type CreateVectorStoreConnectorFileSyncResponse struct {
// The underlying http response
RawResponse *http.Response
// The VectorStoreConnectorFileSync instance
VectorStoreConnectorFileSync `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateVectorStoreConnectorFileSyncResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVectorStoreConnectorFileSyncResponse) String() string
CreateVectorStoreConnectorRequest wrapper for the CreateVectorStoreConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateVectorStoreConnector.go.html to see an example of how to use CreateVectorStoreConnectorRequest.
type CreateVectorStoreConnectorRequest struct {
// Details for the new vectorStoreConnector.
CreateVectorStoreConnectorDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateVectorStoreConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVectorStoreConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVectorStoreConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVectorStoreConnectorRequest) String() string
func (request CreateVectorStoreConnectorRequest) 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
CreateVectorStoreConnectorResponse wrapper for the CreateVectorStoreConnector operation
type CreateVectorStoreConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The VectorStoreConnector instance
VectorStoreConnector `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateVectorStoreConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVectorStoreConnectorResponse) String() string
DataSourceDatabaseToolsConnectionDetails Defines the OCI Database Tools Connection data source that the semantic model connects to.
type DataSourceDatabaseToolsConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI Database Tools Connection for querying.
QueryingConnectionId *string `mandatory:"true" json:"queryingConnectionId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI Database Tools Connection for enrichment.
EnrichmentConnectionId *string `mandatory:"true" json:"enrichmentConnectionId"`
}
func (m DataSourceDatabaseToolsConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DataSourceDatabaseToolsConnectionDetails) String() string
func (m DataSourceDatabaseToolsConnectionDetails) 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
DataSourceDetails Defines the data source that the semantic model connects to.
type DataSourceDetails interface {
}
DataSourceDetailsConnectionTypeEnum Enum with underlying type: string
type DataSourceDetailsConnectionTypeEnum string
Set of constants representing the allowable values for DataSourceDetailsConnectionTypeEnum
const (
DataSourceDetailsConnectionTypeDatabaseToolsConnection DataSourceDetailsConnectionTypeEnum = "DATABASE_TOOLS_CONNECTION"
)
func GetDataSourceDetailsConnectionTypeEnumValues() []DataSourceDetailsConnectionTypeEnum
GetDataSourceDetailsConnectionTypeEnumValues Enumerates the set of values for DataSourceDetailsConnectionTypeEnum
func GetMappingDataSourceDetailsConnectionTypeEnum(val string) (DataSourceDetailsConnectionTypeEnum, bool)
GetMappingDataSourceDetailsConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DatabaseToolsConnection The representation of DatabaseToolsConnection
type DatabaseToolsConnection struct {
}
func (m DatabaseToolsConnection) String() string
func (m DatabaseToolsConnection) 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
Dataset The dataset used to fine-tune the model. Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format:
`{"prompt": "<first prompt>", "completion": "<expected completion given first prompt>"}`
type Dataset interface {
}
DatasetDatasetTypeEnum Enum with underlying type: string
type DatasetDatasetTypeEnum string
Set of constants representing the allowable values for DatasetDatasetTypeEnum
const (
DatasetDatasetTypeObjectStorage DatasetDatasetTypeEnum = "OBJECT_STORAGE"
)
func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum
GetDatasetDatasetTypeEnumValues Enumerates the set of values for DatasetDatasetTypeEnum
func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)
GetMappingDatasetDatasetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedAiCluster Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models. The clusters are dedicated to your models and not shared with users in other tenancies. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type DedicatedAiCluster struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
Id *string `mandatory:"true" json:"id"`
// The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
Type DedicatedAiClusterTypeEnum `mandatory:"true" json:"type"`
// The compartment OCID to create the dedicated AI cluster in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the dedicated AI cluster.
LifecycleState DedicatedAiClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The number of dedicated units in this AI cluster.
UnitCount *int `mandatory:"true" json:"unitCount"`
// The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
UnitShape DedicatedAiClusterUnitShapeEnum `mandatory:"true" json:"unitShape"`
// 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 dedicated AI cluster.
Description *string `mandatory:"false" json:"description"`
// The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state with detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
Capacity DedicatedAiClusterCapacity `mandatory:"false" json:"capacity"`
PreviousState *DedicatedAiCluster `mandatory:"false" json:"previousState"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DedicatedAiCluster) String() string
func (m *DedicatedAiCluster) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DedicatedAiCluster) 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
DedicatedAiClusterCapacity The total capacity for a dedicated AI cluster.
type DedicatedAiClusterCapacity interface {
}
DedicatedAiClusterCapacityCapacityTypeEnum Enum with underlying type: string
type DedicatedAiClusterCapacityCapacityTypeEnum string
Set of constants representing the allowable values for DedicatedAiClusterCapacityCapacityTypeEnum
const (
DedicatedAiClusterCapacityCapacityTypeHostingCapacity DedicatedAiClusterCapacityCapacityTypeEnum = "HOSTING_CAPACITY"
)
func GetDedicatedAiClusterCapacityCapacityTypeEnumValues() []DedicatedAiClusterCapacityCapacityTypeEnum
GetDedicatedAiClusterCapacityCapacityTypeEnumValues Enumerates the set of values for DedicatedAiClusterCapacityCapacityTypeEnum
func GetMappingDedicatedAiClusterCapacityCapacityTypeEnum(val string) (DedicatedAiClusterCapacityCapacityTypeEnum, bool)
GetMappingDedicatedAiClusterCapacityCapacityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedAiClusterCollection Results of a dedicate AI cluster search. Contains DedicatedAiClusterSummary items and other information such as metadata.
type DedicatedAiClusterCollection struct {
// List of dedicated AI clusters.
Items []DedicatedAiClusterSummary `mandatory:"true" json:"items"`
}
func (m DedicatedAiClusterCollection) String() string
func (m DedicatedAiClusterCollection) 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
DedicatedAiClusterHostingCapacity The capacity of a hosting type dedicated AI cluster.
type DedicatedAiClusterHostingCapacity struct {
// The total number of endpoints that can be hosted on this dedicated AI cluster.
TotalEndpointCapacity *int `mandatory:"false" json:"totalEndpointCapacity"`
// The number of endpoints hosted on this dedicated AI cluster.
UsedEndpointCapacity *int `mandatory:"false" json:"usedEndpointCapacity"`
}
func (m DedicatedAiClusterHostingCapacity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DedicatedAiClusterHostingCapacity) String() string
func (m DedicatedAiClusterHostingCapacity) 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
DedicatedAiClusterLifecycleStateEnum Enum with underlying type: string
type DedicatedAiClusterLifecycleStateEnum string
Set of constants representing the allowable values for DedicatedAiClusterLifecycleStateEnum
const (
DedicatedAiClusterLifecycleStateCreating DedicatedAiClusterLifecycleStateEnum = "CREATING"
DedicatedAiClusterLifecycleStateActive DedicatedAiClusterLifecycleStateEnum = "ACTIVE"
DedicatedAiClusterLifecycleStateUpdating DedicatedAiClusterLifecycleStateEnum = "UPDATING"
DedicatedAiClusterLifecycleStateDeleting DedicatedAiClusterLifecycleStateEnum = "DELETING"
DedicatedAiClusterLifecycleStateDeleted DedicatedAiClusterLifecycleStateEnum = "DELETED"
DedicatedAiClusterLifecycleStateFailed DedicatedAiClusterLifecycleStateEnum = "FAILED"
DedicatedAiClusterLifecycleStateNeedsAttention DedicatedAiClusterLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetDedicatedAiClusterLifecycleStateEnumValues() []DedicatedAiClusterLifecycleStateEnum
GetDedicatedAiClusterLifecycleStateEnumValues Enumerates the set of values for DedicatedAiClusterLifecycleStateEnum
func GetMappingDedicatedAiClusterLifecycleStateEnum(val string) (DedicatedAiClusterLifecycleStateEnum, bool)
GetMappingDedicatedAiClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedAiClusterSummary Summary information about a dedicated AI cluster.
type DedicatedAiClusterSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
Id *string `mandatory:"true" json:"id"`
// The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
// Allowed values are:
// - HOSTING
// - FINE_TUNING
Type DedicatedAiClusterTypeEnum `mandatory:"true" json:"type"`
// The compartment OCID to create the dedicated AI cluster in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the dedicated AI cluster was created, in the format defined by RFC 3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the dedicated AI cluster.
// Allowed values are:
// - CREATING
// - ACTIVE
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
// - NEEDS_ATTENTION
LifecycleState DedicatedAiClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The number of dedicated units in this AI cluster.
UnitCount *int `mandatory:"true" json:"unitCount"`
// The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
UnitShape DedicatedAiClusterUnitShapeEnum `mandatory:"true" json:"unitShape"`
// 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 dedicated AI cluster.
Description *string `mandatory:"false" json:"description"`
// The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state of the dedicated AI cluster in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
Capacity DedicatedAiClusterCapacity `mandatory:"false" json:"capacity"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DedicatedAiClusterSummary) String() string
func (m *DedicatedAiClusterSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DedicatedAiClusterSummary) 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
DedicatedAiClusterTypeEnum Enum with underlying type: string
type DedicatedAiClusterTypeEnum string
Set of constants representing the allowable values for DedicatedAiClusterTypeEnum
const (
DedicatedAiClusterTypeHosting DedicatedAiClusterTypeEnum = "HOSTING"
DedicatedAiClusterTypeFineTuning DedicatedAiClusterTypeEnum = "FINE_TUNING"
)
func GetDedicatedAiClusterTypeEnumValues() []DedicatedAiClusterTypeEnum
GetDedicatedAiClusterTypeEnumValues Enumerates the set of values for DedicatedAiClusterTypeEnum
func GetMappingDedicatedAiClusterTypeEnum(val string) (DedicatedAiClusterTypeEnum, bool)
GetMappingDedicatedAiClusterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DedicatedAiClusterUnitShapeEnum Enum with underlying type: string
type DedicatedAiClusterUnitShapeEnum string
Set of constants representing the allowable values for DedicatedAiClusterUnitShapeEnum
const (
DedicatedAiClusterUnitShapeLargeCohere DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE"
DedicatedAiClusterUnitShapeLargeCohereV2 DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE_V2"
DedicatedAiClusterUnitShapeSmallCohere DedicatedAiClusterUnitShapeEnum = "SMALL_COHERE"
DedicatedAiClusterUnitShapeSmallCohereV2 DedicatedAiClusterUnitShapeEnum = "SMALL_COHERE_V2"
DedicatedAiClusterUnitShapeSmallCohere4 DedicatedAiClusterUnitShapeEnum = "SMALL_COHERE_4"
DedicatedAiClusterUnitShapeEmbedCohere DedicatedAiClusterUnitShapeEnum = "EMBED_COHERE"
DedicatedAiClusterUnitShapeLlama270 DedicatedAiClusterUnitShapeEnum = "LLAMA2_70"
DedicatedAiClusterUnitShapeLargeGeneric DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC"
DedicatedAiClusterUnitShapeLargeCohereV22 DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE_V2_2"
DedicatedAiClusterUnitShapeLargeGeneric4 DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC_4"
DedicatedAiClusterUnitShapeSmallGenericV2 DedicatedAiClusterUnitShapeEnum = "SMALL_GENERIC_V2"
DedicatedAiClusterUnitShapeLargeGeneric2 DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC_2"
DedicatedAiClusterUnitShapeLargeGenericV2 DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC_V2"
DedicatedAiClusterUnitShapeLargeGenericV3 DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC_V3"
DedicatedAiClusterUnitShapeLargeCohereV3 DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE_V3"
DedicatedAiClusterUnitShapeRerankCohere DedicatedAiClusterUnitShapeEnum = "RERANK_COHERE"
DedicatedAiClusterUnitShapeSmallGenericV1 DedicatedAiClusterUnitShapeEnum = "SMALL_GENERIC_V1"
DedicatedAiClusterUnitShapeMediumGenericV1 DedicatedAiClusterUnitShapeEnum = "MEDIUM_GENERIC_V1"
DedicatedAiClusterUnitShapeLargeGenericV1 DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC_V1"
DedicatedAiClusterUnitShapeA10X1 DedicatedAiClusterUnitShapeEnum = "A10_X1"
DedicatedAiClusterUnitShapeA10X2 DedicatedAiClusterUnitShapeEnum = "A10_X2"
DedicatedAiClusterUnitShapeA10X4 DedicatedAiClusterUnitShapeEnum = "A10_X4"
DedicatedAiClusterUnitShapeA10040gX1 DedicatedAiClusterUnitShapeEnum = "A100_40G_X1"
DedicatedAiClusterUnitShapeA10040gX2 DedicatedAiClusterUnitShapeEnum = "A100_40G_X2"
DedicatedAiClusterUnitShapeA10040gX4 DedicatedAiClusterUnitShapeEnum = "A100_40G_X4"
DedicatedAiClusterUnitShapeA10040gX8 DedicatedAiClusterUnitShapeEnum = "A100_40G_X8"
DedicatedAiClusterUnitShapeA10080gX1 DedicatedAiClusterUnitShapeEnum = "A100_80G_X1"
DedicatedAiClusterUnitShapeA10080gX2 DedicatedAiClusterUnitShapeEnum = "A100_80G_X2"
DedicatedAiClusterUnitShapeA10080gX4 DedicatedAiClusterUnitShapeEnum = "A100_80G_X4"
DedicatedAiClusterUnitShapeA10080gX8 DedicatedAiClusterUnitShapeEnum = "A100_80G_X8"
DedicatedAiClusterUnitShapeH100X1 DedicatedAiClusterUnitShapeEnum = "H100_X1"
DedicatedAiClusterUnitShapeH100X2 DedicatedAiClusterUnitShapeEnum = "H100_X2"
DedicatedAiClusterUnitShapeH100X4 DedicatedAiClusterUnitShapeEnum = "H100_X4"
DedicatedAiClusterUnitShapeH100X8 DedicatedAiClusterUnitShapeEnum = "H100_X8"
DedicatedAiClusterUnitShapeH200X1 DedicatedAiClusterUnitShapeEnum = "H200_X1"
DedicatedAiClusterUnitShapeH200X2 DedicatedAiClusterUnitShapeEnum = "H200_X2"
DedicatedAiClusterUnitShapeH200X4 DedicatedAiClusterUnitShapeEnum = "H200_X4"
DedicatedAiClusterUnitShapeH200X8 DedicatedAiClusterUnitShapeEnum = "H200_X8"
DedicatedAiClusterUnitShapeOaiA10X2 DedicatedAiClusterUnitShapeEnum = "OAI_A10_X2"
DedicatedAiClusterUnitShapeOaiH100X1 DedicatedAiClusterUnitShapeEnum = "OAI_H100_X1"
DedicatedAiClusterUnitShapeOaiH100X2 DedicatedAiClusterUnitShapeEnum = "OAI_H100_X2"
DedicatedAiClusterUnitShapeOaiH200X1 DedicatedAiClusterUnitShapeEnum = "OAI_H200_X1"
DedicatedAiClusterUnitShapeOaiA10080gX1 DedicatedAiClusterUnitShapeEnum = "OAI_A100_80G_X1"
DedicatedAiClusterUnitShapeOaiA10080gX2 DedicatedAiClusterUnitShapeEnum = "OAI_A100_80G_X2"
DedicatedAiClusterUnitShapeOaiA10040gX1 DedicatedAiClusterUnitShapeEnum = "OAI_A100_40G_X1"
DedicatedAiClusterUnitShapeOaiA10040gX4 DedicatedAiClusterUnitShapeEnum = "OAI_A100_40G_X4"
)
func GetDedicatedAiClusterUnitShapeEnumValues() []DedicatedAiClusterUnitShapeEnum
GetDedicatedAiClusterUnitShapeEnumValues Enumerates the set of values for DedicatedAiClusterUnitShapeEnum
func GetMappingDedicatedAiClusterUnitShapeEnum(val string) (DedicatedAiClusterUnitShapeEnum, bool)
GetMappingDedicatedAiClusterUnitShapeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteApiKeyRequest wrapper for the DeleteApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteApiKey.go.html to see an example of how to use DeleteApiKeyRequest.
type DeleteApiKeyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApiKeyRequest) String() string
func (request DeleteApiKeyRequest) 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
DeleteApiKeyResponse wrapper for the DeleteApiKey operation
type DeleteApiKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApiKeyResponse) String() string
DeleteDedicatedAiClusterRequest wrapper for the DeleteDedicatedAiCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteDedicatedAiCluster.go.html to see an example of how to use DeleteDedicatedAiClusterRequest.
type DeleteDedicatedAiClusterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
DedicatedAiClusterId *string `mandatory:"true" contributesTo:"path" name:"dedicatedAiClusterId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDedicatedAiClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDedicatedAiClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDedicatedAiClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDedicatedAiClusterRequest) String() string
func (request DeleteDedicatedAiClusterRequest) 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
DeleteDedicatedAiClusterResponse wrapper for the DeleteDedicatedAiCluster operation
type DeleteDedicatedAiClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDedicatedAiClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDedicatedAiClusterResponse) String() string
DeleteEndpointRequest wrapper for the DeleteEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteEndpoint.go.html to see an example of how to use DeleteEndpointRequest.
type DeleteEndpointRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEndpointRequest) String() string
func (request DeleteEndpointRequest) 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
DeleteEndpointResponse wrapper for the DeleteEndpoint operation
type DeleteEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEndpointResponse) String() string
DeleteGenerativeAiPrivateEndpointRequest wrapper for the DeleteGenerativeAiPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteGenerativeAiPrivateEndpoint.go.html to see an example of how to use DeleteGenerativeAiPrivateEndpointRequest.
type DeleteGenerativeAiPrivateEndpointRequest struct {
// The unique id for a Generative AI private endpoint.
GenerativeAiPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"generativeAiPrivateEndpointId"`
// 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 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteGenerativeAiPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGenerativeAiPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGenerativeAiPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGenerativeAiPrivateEndpointRequest) String() string
func (request DeleteGenerativeAiPrivateEndpointRequest) 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
DeleteGenerativeAiPrivateEndpointResponse wrapper for the DeleteGenerativeAiPrivateEndpoint operation
type DeleteGenerativeAiPrivateEndpointResponse 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"`
// The OCID (https://docs.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"`
}
func (response DeleteGenerativeAiPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGenerativeAiPrivateEndpointResponse) String() string
DeleteGenerativeAiProjectRequest wrapper for the DeleteGenerativeAiProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteGenerativeAiProject.go.html to see an example of how to use DeleteGenerativeAiProjectRequest.
type DeleteGenerativeAiProjectRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject.
GenerativeAiProjectId *string `mandatory:"true" contributesTo:"path" name:"generativeAiProjectId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteGenerativeAiProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGenerativeAiProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGenerativeAiProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGenerativeAiProjectRequest) String() string
func (request DeleteGenerativeAiProjectRequest) 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
DeleteGenerativeAiProjectResponse wrapper for the DeleteGenerativeAiProject operation
type DeleteGenerativeAiProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteGenerativeAiProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGenerativeAiProjectResponse) String() string
DeleteHostedApplicationRequest wrapper for the DeleteHostedApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedApplication.go.html to see an example of how to use DeleteHostedApplicationRequest.
type DeleteHostedApplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
HostedApplicationId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteHostedApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHostedApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHostedApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHostedApplicationRequest) String() string
func (request DeleteHostedApplicationRequest) 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
DeleteHostedApplicationResponse wrapper for the DeleteHostedApplication operation
type DeleteHostedApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteHostedApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHostedApplicationResponse) String() string
DeleteHostedApplicationStorageRequest wrapper for the DeleteHostedApplicationStorage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedApplicationStorage.go.html to see an example of how to use DeleteHostedApplicationStorageRequest.
type DeleteHostedApplicationStorageRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage.
HostedApplicationStorageId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationStorageId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteHostedApplicationStorageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHostedApplicationStorageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHostedApplicationStorageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHostedApplicationStorageRequest) String() string
func (request DeleteHostedApplicationStorageRequest) 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
DeleteHostedApplicationStorageResponse wrapper for the DeleteHostedApplicationStorage operation
type DeleteHostedApplicationStorageResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteHostedApplicationStorageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHostedApplicationStorageResponse) String() string
DeleteHostedDeploymentArtifactRequest wrapper for the DeleteHostedDeploymentArtifact operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedDeploymentArtifact.go.html to see an example of how to use DeleteHostedDeploymentArtifactRequest.
type DeleteHostedDeploymentArtifactRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
HostedDeploymentId *string `mandatory:"true" contributesTo:"path" name:"hostedDeploymentId"`
// The id of the artifact.
ArtifactId *string `mandatory:"true" contributesTo:"path" name:"artifactId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteHostedDeploymentArtifactRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHostedDeploymentArtifactRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHostedDeploymentArtifactRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHostedDeploymentArtifactRequest) String() string
func (request DeleteHostedDeploymentArtifactRequest) 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
DeleteHostedDeploymentArtifactResponse wrapper for the DeleteHostedDeploymentArtifact operation
type DeleteHostedDeploymentArtifactResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteHostedDeploymentArtifactResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHostedDeploymentArtifactResponse) String() string
DeleteHostedDeploymentRequest wrapper for the DeleteHostedDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedDeployment.go.html to see an example of how to use DeleteHostedDeploymentRequest.
type DeleteHostedDeploymentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
HostedDeploymentId *string `mandatory:"true" contributesTo:"path" name:"hostedDeploymentId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteHostedDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHostedDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHostedDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHostedDeploymentRequest) String() string
func (request DeleteHostedDeploymentRequest) 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
DeleteHostedDeploymentResponse wrapper for the DeleteHostedDeployment operation
type DeleteHostedDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteHostedDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHostedDeploymentResponse) String() string
DeleteImportedModelRequest wrapper for the DeleteImportedModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteImportedModel.go.html to see an example of how to use DeleteImportedModelRequest.
type DeleteImportedModelRequest struct {
// The importedModel OCID
ImportedModelId *string `mandatory:"true" contributesTo:"path" name:"importedModelId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteImportedModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteImportedModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteImportedModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteImportedModelRequest) String() string
func (request DeleteImportedModelRequest) 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
DeleteImportedModelResponse wrapper for the DeleteImportedModel operation
type DeleteImportedModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteImportedModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteImportedModelResponse) String() string
DeleteModelRequest wrapper for the DeleteModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteModel.go.html to see an example of how to use DeleteModelRequest.
type DeleteModelRequest struct {
// The model OCID
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteModelRequest) String() string
func (request DeleteModelRequest) 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
DeleteModelResponse wrapper for the DeleteModel operation
type DeleteModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteModelResponse) String() string
DeleteSemanticStoreRequest wrapper for the DeleteSemanticStore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteSemanticStore.go.html to see an example of how to use DeleteSemanticStoreRequest.
type DeleteSemanticStoreRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore.
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteSemanticStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSemanticStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSemanticStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSemanticStoreRequest) String() string
func (request DeleteSemanticStoreRequest) 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
DeleteSemanticStoreResponse wrapper for the DeleteSemanticStore operation
type DeleteSemanticStoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteSemanticStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSemanticStoreResponse) String() string
DeleteVectorStoreConnectorRequest wrapper for the DeleteVectorStoreConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteVectorStoreConnector.go.html to see an example of how to use DeleteVectorStoreConnectorRequest.
type DeleteVectorStoreConnectorRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
VectorStoreConnectorId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteVectorStoreConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteVectorStoreConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteVectorStoreConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteVectorStoreConnectorRequest) String() string
func (request DeleteVectorStoreConnectorRequest) 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
DeleteVectorStoreConnectorResponse wrapper for the DeleteVectorStoreConnector operation
type DeleteVectorStoreConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteVectorStoreConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteVectorStoreConnectorResponse) String() string
EmbeddingConfig Configuration for generating embeddings from extracted information.
type EmbeddingConfig struct {
LlmSelection LlmSelection `mandatory:"true" json:"llmSelection"`
}
func (m EmbeddingConfig) GetLlmSelection() LlmSelection
GetLlmSelection returns LlmSelection
func (m EmbeddingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m EmbeddingConfig) String() string
func (m *EmbeddingConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m EmbeddingConfig) 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
Endpoint To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster of type HOSTING. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type Endpoint struct {
// An OCID that uniquely identifies this endpoint resource.
Id *string `mandatory:"true" json:"id"`
// The OCID of the model that's used to create this endpoint.
ModelId *string `mandatory:"true" json:"modelId"`
// The compartment OCID to create the endpoint in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the dedicated AI cluster on which the model will be deployed to.
DedicatedAiClusterId *string `mandatory:"true" json:"dedicatedAiClusterId"`
// The date and time that the endpoint was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the endpoint.
LifecycleState EndpointLifecycleStateEnum `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"`
// The OCID of the Generative AI private endpoint to which this endpoint is attached to.
GenerativeAiPrivateEndpointId *string `mandatory:"false" json:"generativeAiPrivateEndpointId"`
// The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state of the endpoint in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
PromptInjectionConfig *PromptInjectionConfig `mandatory:"false" json:"promptInjectionConfig"`
PiiDetectionConfig *PiiDetectionConfig `mandatory:"false" json:"piiDetectionConfig"`
PreviousState *Endpoint `mandatory:"false" json:"previousState"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Endpoint) String() string
func (m Endpoint) 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
EndpointCollection Results of an endpoint search. Contains EndpointSummary items and other information such as metadata.
type EndpointCollection struct {
// List of endpoints.
Items []EndpointSummary `mandatory:"true" json:"items"`
}
func (m EndpointCollection) String() string
func (m EndpointCollection) 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
EndpointLifecycleStateEnum Enum with underlying type: string
type EndpointLifecycleStateEnum string
Set of constants representing the allowable values for EndpointLifecycleStateEnum
const (
EndpointLifecycleStateActive EndpointLifecycleStateEnum = "ACTIVE"
EndpointLifecycleStateCreating EndpointLifecycleStateEnum = "CREATING"
EndpointLifecycleStateUpdating EndpointLifecycleStateEnum = "UPDATING"
EndpointLifecycleStateDeleting EndpointLifecycleStateEnum = "DELETING"
EndpointLifecycleStateDeleted EndpointLifecycleStateEnum = "DELETED"
EndpointLifecycleStateFailed EndpointLifecycleStateEnum = "FAILED"
)
func GetEndpointLifecycleStateEnumValues() []EndpointLifecycleStateEnum
GetEndpointLifecycleStateEnumValues Enumerates the set of values for EndpointLifecycleStateEnum
func GetMappingEndpointLifecycleStateEnum(val string) (EndpointLifecycleStateEnum, bool)
GetMappingEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
EndpointSummary Summary information for an endpoint resource.
type EndpointSummary struct {
// An OCID that uniquely identifies this endpoint resource.
Id *string `mandatory:"true" json:"id"`
// The OCID of the model that's used to create this endpoint.
ModelId *string `mandatory:"true" json:"modelId"`
// The compartment OCID to create the endpoint in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the dedicated AI cluster on which a model will be deployed to.
DedicatedAiClusterId *string `mandatory:"true" json:"dedicatedAiClusterId"`
// The date and time that the endpoint was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the endpoint.
// Allowed values are:
// - ACTIVE
// - CREATING
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState EndpointLifecycleStateEnum `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"`
// The OCID of the Generative AI private endpoint to which this endpoint is attached to.
GenerativeAiPrivateEndpointId *string `mandatory:"false" json:"generativeAiPrivateEndpointId"`
// The date and time the endpoint was updated in the format of n RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state with detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
PromptInjectionConfig *PromptInjectionConfig `mandatory:"false" json:"promptInjectionConfig"`
PiiDetectionConfig *PiiDetectionConfig `mandatory:"false" json:"piiDetectionConfig"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EndpointSummary) String() string
func (m EndpointSummary) 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
EnvironmentVariable The environment variables for the Hosted Application
type EnvironmentVariable struct {
// Name of the environment variable.
Name *string `mandatory:"true" json:"name"`
// Type of the environment variable (PLAINTEXT or HASHED, no default value).
Type EnvironmentVariableTypeEnum `mandatory:"true" json:"type"`
// Value of the environment variable.
Value *interface{} `mandatory:"true" json:"value"`
}
func (m EnvironmentVariable) String() string
func (m EnvironmentVariable) 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
EnvironmentVariableTypeEnum Enum with underlying type: string
type EnvironmentVariableTypeEnum string
Set of constants representing the allowable values for EnvironmentVariableTypeEnum
const (
EnvironmentVariableTypePlaintext EnvironmentVariableTypeEnum = "PLAINTEXT"
EnvironmentVariableTypeVault EnvironmentVariableTypeEnum = "VAULT"
)
func GetEnvironmentVariableTypeEnumValues() []EnvironmentVariableTypeEnum
GetEnvironmentVariableTypeEnumValues Enumerates the set of values for EnvironmentVariableTypeEnum
func GetMappingEnvironmentVariableTypeEnum(val string) (EnvironmentVariableTypeEnum, bool)
GetMappingEnvironmentVariableTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ExtractionConfig Configuration for information extraction from conversation content.
type ExtractionConfig struct {
LlmSelection LlmSelection `mandatory:"true" json:"llmSelection"`
}
func (m ExtractionConfig) GetLlmSelection() LlmSelection
GetLlmSelection returns LlmSelection
func (m ExtractionConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExtractionConfig) String() string
func (m *ExtractionConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ExtractionConfig) 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
FileSyncIngestionLogs A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector
type FileSyncIngestionLogs struct {
// An identifier that identifies a File ingested to a VectorStore.
FileId *string `mandatory:"true" json:"fileId"`
// The path where the file was located in the datasource.
FilePath *string `mandatory:"true" json:"filePath"`
// The current status of ingestion for the File
Status FileSyncIngestionLogsStatusEnum `mandatory:"true" json:"status"`
// The size of the file.
FileSizeInBytes *int `mandatory:"false" json:"fileSizeInBytes"`
// The total number of chunks created from the File.
TotalChunksCreated *int `mandatory:"false" json:"totalChunksCreated"`
// The duration taken(in seconds) to ingest the File.
DurationInSeconds *int `mandatory:"false" json:"durationInSeconds"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FileSyncIngestionLogs) String() string
func (m FileSyncIngestionLogs) 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
FileSyncIngestionLogsCollection Results of a VectorStoreConnector Ingestion Log search.
type FileSyncIngestionLogsCollection struct {
// List of VectorStoreConnectorIngestionLogs objects.
Items []FileSyncIngestionLogs `mandatory:"true" json:"items"`
}
func (m FileSyncIngestionLogsCollection) String() string
func (m FileSyncIngestionLogsCollection) 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
FileSyncIngestionLogsStatusEnum Enum with underlying type: string
type FileSyncIngestionLogsStatusEnum string
Set of constants representing the allowable values for FileSyncIngestionLogsStatusEnum
const (
FileSyncIngestionLogsStatusCompleted FileSyncIngestionLogsStatusEnum = "COMPLETED"
FileSyncIngestionLogsStatusCancelled FileSyncIngestionLogsStatusEnum = "CANCELLED"
FileSyncIngestionLogsStatusFailed FileSyncIngestionLogsStatusEnum = "FAILED"
FileSyncIngestionLogsStatusQueued FileSyncIngestionLogsStatusEnum = "QUEUED"
FileSyncIngestionLogsStatusInProgress FileSyncIngestionLogsStatusEnum = "IN_PROGRESS"
)
func GetFileSyncIngestionLogsStatusEnumValues() []FileSyncIngestionLogsStatusEnum
GetFileSyncIngestionLogsStatusEnumValues Enumerates the set of values for FileSyncIngestionLogsStatusEnum
func GetMappingFileSyncIngestionLogsStatusEnum(val string) (FileSyncIngestionLogsStatusEnum, bool)
GetMappingFileSyncIngestionLogsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
FileSyncStatistics Synchronization Statistics for a VectorStore File Sync operation or for a VectorStore Connector
type FileSyncStatistics struct {
// The total number of files synchronized from the datasource.
TotalFilesSynced *int `mandatory:"false" json:"totalFilesSynced"`
// FileSync Statistics for different file types.
SyncStatsByFileType map[string]int `mandatory:"false" json:"syncStatsByFileType"`
}
func (m FileSyncStatistics) String() string
func (m FileSyncStatistics) 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
FineTuneDetails Details about fine-tuning a custom model.
type FineTuneDetails struct {
TrainingDataset Dataset `mandatory:"true" json:"trainingDataset"`
// The OCID of the dedicated AI cluster this fine-tuning runs on.
DedicatedAiClusterId *string `mandatory:"true" json:"dedicatedAiClusterId"`
TrainingConfig TrainingConfig `mandatory:"false" json:"trainingConfig"`
}
func (m FineTuneDetails) String() string
func (m *FineTuneDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m FineTuneDetails) 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
GenAiModelLlmSelection LLM selection with specific Gen AI model.
type GenAiModelLlmSelection struct {
// The id of the GenAI model
ModelId *string `mandatory:"true" json:"modelId"`
}
func (m GenAiModelLlmSelection) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m GenAiModelLlmSelection) String() string
func (m GenAiModelLlmSelection) 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
GenerativeAiClient a client for GenerativeAi
type GenerativeAiClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGenerativeAiClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenerativeAiClient, err error)
NewGenerativeAiClientWithConfigurationProvider Creates a new default GenerativeAi client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGenerativeAiClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenerativeAiClient, err error)
NewGenerativeAiClientWithOboToken Creates a new default GenerativeAi client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client GenerativeAiClient) AddArtifact(ctx context.Context, request AddArtifactRequest) (response AddArtifactResponse, err error)
AddArtifact add image with isAutoDeploy flag.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/AddArtifact.go.html to see an example of how to use AddArtifact API. A default retry strategy applies to this operation AddArtifact()
func (client GenerativeAiClient) CancelVectorStoreConnectorFileSync(ctx context.Context, request CancelVectorStoreConnectorFileSyncRequest) (response CancelVectorStoreConnectorFileSyncResponse, err error)
CancelVectorStoreConnectorFileSync Cancels a vectorStoreConnectorFileSync.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CancelVectorStoreConnectorFileSync.go.html to see an example of how to use CancelVectorStoreConnectorFileSync API. A default retry strategy applies to this operation CancelVectorStoreConnectorFileSync()
func (client GenerativeAiClient) ChangeApiKeyCompartment(ctx context.Context, request ChangeApiKeyCompartmentRequest) (response ChangeApiKeyCompartmentResponse, err error)
ChangeApiKeyCompartment Moves an API key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeApiKeyCompartment.go.html to see an example of how to use ChangeApiKeyCompartment API. A default retry strategy applies to this operation ChangeApiKeyCompartment()
func (client GenerativeAiClient) ChangeDedicatedAiClusterCompartment(ctx context.Context, request ChangeDedicatedAiClusterCompartmentRequest) (response ChangeDedicatedAiClusterCompartmentResponse, err error)
ChangeDedicatedAiClusterCompartment Moves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeDedicatedAiClusterCompartment.go.html to see an example of how to use ChangeDedicatedAiClusterCompartment API. A default retry strategy applies to this operation ChangeDedicatedAiClusterCompartment()
func (client GenerativeAiClient) ChangeEndpointCompartment(ctx context.Context, request ChangeEndpointCompartmentRequest) (response ChangeEndpointCompartmentResponse, err error)
ChangeEndpointCompartment 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.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeEndpointCompartment.go.html to see an example of how to use ChangeEndpointCompartment API. A default retry strategy applies to this operation ChangeEndpointCompartment()
func (client GenerativeAiClient) ChangeGenerativeAiPrivateEndpointCompartment(ctx context.Context, request ChangeGenerativeAiPrivateEndpointCompartmentRequest) (response ChangeGenerativeAiPrivateEndpointCompartmentResponse, err error)
ChangeGenerativeAiPrivateEndpointCompartment Moves a Generative AI private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeGenerativeAiPrivateEndpointCompartment.go.html to see an example of how to use ChangeGenerativeAiPrivateEndpointCompartment API. A default retry strategy applies to this operation ChangeGenerativeAiPrivateEndpointCompartment()
func (client GenerativeAiClient) ChangeGenerativeAiProjectCompartment(ctx context.Context, request ChangeGenerativeAiProjectCompartmentRequest) (response ChangeGenerativeAiProjectCompartmentResponse, err error)
ChangeGenerativeAiProjectCompartment Moves a generativeAiProject into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeGenerativeAiProjectCompartment.go.html to see an example of how to use ChangeGenerativeAiProjectCompartment API. A default retry strategy applies to this operation ChangeGenerativeAiProjectCompartment()
func (client GenerativeAiClient) ChangeHostedApplicationCompartment(ctx context.Context, request ChangeHostedApplicationCompartmentRequest) (response ChangeHostedApplicationCompartmentResponse, err error)
ChangeHostedApplicationCompartment Moves a hosted application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeHostedApplicationCompartment.go.html to see an example of how to use ChangeHostedApplicationCompartment API. A default retry strategy applies to this operation ChangeHostedApplicationCompartment()
func (client GenerativeAiClient) ChangeHostedApplicationStorageCompartment(ctx context.Context, request ChangeHostedApplicationStorageCompartmentRequest) (response ChangeHostedApplicationStorageCompartmentResponse, err error)
ChangeHostedApplicationStorageCompartment Moves a hosted application storage into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeHostedApplicationStorageCompartment.go.html to see an example of how to use ChangeHostedApplicationStorageCompartment API. A default retry strategy applies to this operation ChangeHostedApplicationStorageCompartment()
func (client GenerativeAiClient) ChangeImportedModelCompartment(ctx context.Context, request ChangeImportedModelCompartmentRequest) (response ChangeImportedModelCompartmentResponse, err error)
ChangeImportedModelCompartment Moves an imported model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeImportedModelCompartment.go.html to see an example of how to use ChangeImportedModelCompartment API. A default retry strategy applies to this operation ChangeImportedModelCompartment()
func (client GenerativeAiClient) ChangeModelCompartment(ctx context.Context, request ChangeModelCompartmentRequest) (response ChangeModelCompartmentResponse, err error)
ChangeModelCompartment Moves a custom model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartment API. A default retry strategy applies to this operation ChangeModelCompartment()
func (client GenerativeAiClient) ChangeSemanticStoreCompartment(ctx context.Context, request ChangeSemanticStoreCompartmentRequest) (response ChangeSemanticStoreCompartmentResponse, err error)
ChangeSemanticStoreCompartment Moves a SemanticStore into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ChangeSemanticStoreCompartment.go.html to see an example of how to use ChangeSemanticStoreCompartment API. A default retry strategy applies to this operation ChangeSemanticStoreCompartment()
func (client *GenerativeAiClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GenerativeAiClient) CreateApiKey(ctx context.Context, request CreateApiKeyRequest) (response CreateApiKeyResponse, err error)
CreateApiKey Creates a new API key in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateApiKey.go.html to see an example of how to use CreateApiKey API. A default retry strategy applies to this operation CreateApiKey()
func (client GenerativeAiClient) CreateDedicatedAiCluster(ctx context.Context, request CreateDedicatedAiClusterRequest) (response CreateDedicatedAiClusterResponse, err error)
CreateDedicatedAiCluster Creates a dedicated AI cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateDedicatedAiCluster.go.html to see an example of how to use CreateDedicatedAiCluster API. A default retry strategy applies to this operation CreateDedicatedAiCluster()
func (client GenerativeAiClient) CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (response CreateEndpointResponse, err error)
CreateEndpoint Creates an endpoint. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateEndpoint.go.html to see an example of how to use CreateEndpoint API. A default retry strategy applies to this operation CreateEndpoint()
func (client GenerativeAiClient) CreateGenerativeAiPrivateEndpoint(ctx context.Context, request CreateGenerativeAiPrivateEndpointRequest) (response CreateGenerativeAiPrivateEndpointResponse, err error)
CreateGenerativeAiPrivateEndpoint Creates a Generative AI private endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateGenerativeAiPrivateEndpoint.go.html to see an example of how to use CreateGenerativeAiPrivateEndpoint API. A default retry strategy applies to this operation CreateGenerativeAiPrivateEndpoint()
func (client GenerativeAiClient) CreateGenerativeAiProject(ctx context.Context, request CreateGenerativeAiProjectRequest) (response CreateGenerativeAiProjectResponse, err error)
CreateGenerativeAiProject Creates a GenerativeAiProject. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the generativeAiProject creation progress.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateGenerativeAiProject.go.html to see an example of how to use CreateGenerativeAiProject API. A default retry strategy applies to this operation CreateGenerativeAiProject()
func (client GenerativeAiClient) CreateHostedApplication(ctx context.Context, request CreateHostedApplicationRequest) (response CreateHostedApplicationResponse, err error)
CreateHostedApplication Creates a hosted application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateHostedApplication.go.html to see an example of how to use CreateHostedApplication API. A default retry strategy applies to this operation CreateHostedApplication()
func (client GenerativeAiClient) CreateHostedApplicationStorage(ctx context.Context, request CreateHostedApplicationStorageRequest) (response CreateHostedApplicationStorageResponse, err error)
CreateHostedApplicationStorage Creates a hosted application storage.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateHostedApplicationStorage.go.html to see an example of how to use CreateHostedApplicationStorage API. A default retry strategy applies to this operation CreateHostedApplicationStorage()
func (client GenerativeAiClient) CreateHostedDeployment(ctx context.Context, request CreateHostedDeploymentRequest) (response CreateHostedDeploymentResponse, err error)
CreateHostedDeployment Creates a hosted deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateHostedDeployment.go.html to see an example of how to use CreateHostedDeployment API. A default retry strategy applies to this operation CreateHostedDeployment()
func (client GenerativeAiClient) CreateImportedModel(ctx context.Context, request CreateImportedModelRequest) (response CreateImportedModelResponse, err error)
CreateImportedModel Import a model from ModelDataSource. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the importedModel creation progress.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateImportedModel.go.html to see an example of how to use CreateImportedModel API. A default retry strategy applies to this operation CreateImportedModel()
func (client GenerativeAiClient) CreateModel(ctx context.Context, request CreateModelRequest) (response CreateModelResponse, err error)
CreateModel Creates a custom model by fine-tuning a base model with your own dataset. You can create a new custom models or create a new version of existing custom model.. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateModel.go.html to see an example of how to use CreateModel API. A default retry strategy applies to this operation CreateModel()
func (client GenerativeAiClient) CreateSemanticStore(ctx context.Context, request CreateSemanticStoreRequest) (response CreateSemanticStoreResponse, err error)
CreateSemanticStore Creates a SemanticStore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateSemanticStore.go.html to see an example of how to use CreateSemanticStore API. A default retry strategy applies to this operation CreateSemanticStore()
func (client GenerativeAiClient) CreateVectorStoreConnector(ctx context.Context, request CreateVectorStoreConnectorRequest) (response CreateVectorStoreConnectorResponse, err error)
CreateVectorStoreConnector Creates a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnector creation progress.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateVectorStoreConnector.go.html to see an example of how to use CreateVectorStoreConnector API. A default retry strategy applies to this operation CreateVectorStoreConnector()
func (client GenerativeAiClient) CreateVectorStoreConnectorFileSync(ctx context.Context, request CreateVectorStoreConnectorFileSyncRequest) (response CreateVectorStoreConnectorFileSyncResponse, err error)
CreateVectorStoreConnectorFileSync Creates a File Sync operation for a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnectorFileSync creation progress.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/CreateVectorStoreConnectorFileSync.go.html to see an example of how to use CreateVectorStoreConnectorFileSync API. A default retry strategy applies to this operation CreateVectorStoreConnectorFileSync()
func (client GenerativeAiClient) DeleteApiKey(ctx context.Context, request DeleteApiKeyRequest) (response DeleteApiKeyResponse, err error)
DeleteApiKey Deletes an API key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteApiKey.go.html to see an example of how to use DeleteApiKey API. A default retry strategy applies to this operation DeleteApiKey()
func (client GenerativeAiClient) DeleteDedicatedAiCluster(ctx context.Context, request DeleteDedicatedAiClusterRequest) (response DeleteDedicatedAiClusterResponse, err error)
DeleteDedicatedAiCluster Deletes a dedicated AI cluster. You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can't be undone.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteDedicatedAiCluster.go.html to see an example of how to use DeleteDedicatedAiCluster API. A default retry strategy applies to this operation DeleteDedicatedAiCluster()
func (client GenerativeAiClient) DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) (response DeleteEndpointResponse, err error)
DeleteEndpoint Deletes an endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteEndpoint.go.html to see an example of how to use DeleteEndpoint API. A default retry strategy applies to this operation DeleteEndpoint()
func (client GenerativeAiClient) DeleteGenerativeAiPrivateEndpoint(ctx context.Context, request DeleteGenerativeAiPrivateEndpointRequest) (response DeleteGenerativeAiPrivateEndpointResponse, err error)
DeleteGenerativeAiPrivateEndpoint Deletes a Generative AI private endpoint using `privateEndpointId`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteGenerativeAiPrivateEndpoint.go.html to see an example of how to use DeleteGenerativeAiPrivateEndpoint API. A default retry strategy applies to this operation DeleteGenerativeAiPrivateEndpoint()
func (client GenerativeAiClient) DeleteGenerativeAiProject(ctx context.Context, request DeleteGenerativeAiProjectRequest) (response DeleteGenerativeAiProjectResponse, err error)
DeleteGenerativeAiProject Deletes a generativeAiProject.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteGenerativeAiProject.go.html to see an example of how to use DeleteGenerativeAiProject API. A default retry strategy applies to this operation DeleteGenerativeAiProject()
func (client GenerativeAiClient) DeleteHostedApplication(ctx context.Context, request DeleteHostedApplicationRequest) (response DeleteHostedApplicationResponse, err error)
DeleteHostedApplication Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can't be undone.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedApplication.go.html to see an example of how to use DeleteHostedApplication API. A default retry strategy applies to this operation DeleteHostedApplication()
func (client GenerativeAiClient) DeleteHostedApplicationStorage(ctx context.Context, request DeleteHostedApplicationStorageRequest) (response DeleteHostedApplicationStorageResponse, err error)
DeleteHostedApplicationStorage Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can't be undone.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedApplicationStorage.go.html to see an example of how to use DeleteHostedApplicationStorage API. A default retry strategy applies to this operation DeleteHostedApplicationStorage()
func (client GenerativeAiClient) DeleteHostedDeployment(ctx context.Context, request DeleteHostedDeploymentRequest) (response DeleteHostedDeploymentResponse, err error)
DeleteHostedDeployment Deletes a hosted deployment. You can only delete hosted deployment without attached resources. Before you delete a hosting hosted deployment, you must delete the endpoints associated to that deployment. Before you delete a fine-tuning hosted deployment, you must delete the custom model on that deployment. The delete action permanently deletes the cluster. This action can't be undone.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedDeployment.go.html to see an example of how to use DeleteHostedDeployment API. A default retry strategy applies to this operation DeleteHostedDeployment()
func (client GenerativeAiClient) DeleteHostedDeploymentArtifact(ctx context.Context, request DeleteHostedDeploymentArtifactRequest) (response DeleteHostedDeploymentArtifactResponse, err error)
DeleteHostedDeploymentArtifact delete artifact.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteHostedDeploymentArtifact.go.html to see an example of how to use DeleteHostedDeploymentArtifact API. A default retry strategy applies to this operation DeleteHostedDeploymentArtifact()
func (client GenerativeAiClient) DeleteImportedModel(ctx context.Context, request DeleteImportedModelRequest) (response DeleteImportedModelResponse, err error)
DeleteImportedModel Deletes an imported model. An imported model shouldn't be deleted if there's one or more active endpoints associated with that imported model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteImportedModel.go.html to see an example of how to use DeleteImportedModel API. A default retry strategy applies to this operation DeleteImportedModel()
func (client GenerativeAiClient) DeleteModel(ctx context.Context, request DeleteModelRequest) (response DeleteModelResponse, err error)
DeleteModel Deletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with that model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteModel.go.html to see an example of how to use DeleteModel API. A default retry strategy applies to this operation DeleteModel()
func (client GenerativeAiClient) DeleteSemanticStore(ctx context.Context, request DeleteSemanticStoreRequest) (response DeleteSemanticStoreResponse, err error)
DeleteSemanticStore Deletes a semanticStore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteSemanticStore.go.html to see an example of how to use DeleteSemanticStore API. A default retry strategy applies to this operation DeleteSemanticStore()
func (client GenerativeAiClient) DeleteVectorStoreConnector(ctx context.Context, request DeleteVectorStoreConnectorRequest) (response DeleteVectorStoreConnectorResponse, err error)
DeleteVectorStoreConnector Deletes a vectorStoreConnector.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/DeleteVectorStoreConnector.go.html to see an example of how to use DeleteVectorStoreConnector API. A default retry strategy applies to this operation DeleteVectorStoreConnector()
func (client GenerativeAiClient) GetApiKey(ctx context.Context, request GetApiKeyRequest) (response GetApiKeyResponse, err error)
GetApiKey Gets information about an API key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetApiKey.go.html to see an example of how to use GetApiKey API. A default retry strategy applies to this operation GetApiKey()
func (client GenerativeAiClient) GetDedicatedAiCluster(ctx context.Context, request GetDedicatedAiClusterRequest) (response GetDedicatedAiClusterResponse, err error)
GetDedicatedAiCluster Gets information about a dedicated AI cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetDedicatedAiCluster.go.html to see an example of how to use GetDedicatedAiCluster API. A default retry strategy applies to this operation GetDedicatedAiCluster()
func (client GenerativeAiClient) GetEndpoint(ctx context.Context, request GetEndpointRequest) (response GetEndpointResponse, err error)
GetEndpoint Gets information about an endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetEndpoint.go.html to see an example of how to use GetEndpoint API. A default retry strategy applies to this operation GetEndpoint()
func (client GenerativeAiClient) GetGenerativeAiPrivateEndpoint(ctx context.Context, request GetGenerativeAiPrivateEndpointRequest) (response GetGenerativeAiPrivateEndpointResponse, err error)
GetGenerativeAiPrivateEndpoint Retrieves an Generative AI private endpoint using a `privateEndpointId`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetGenerativeAiPrivateEndpoint.go.html to see an example of how to use GetGenerativeAiPrivateEndpoint API. A default retry strategy applies to this operation GetGenerativeAiPrivateEndpoint()
func (client GenerativeAiClient) GetGenerativeAiProject(ctx context.Context, request GetGenerativeAiProjectRequest) (response GetGenerativeAiProjectResponse, err error)
GetGenerativeAiProject Gets information about a generativeAiProject.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetGenerativeAiProject.go.html to see an example of how to use GetGenerativeAiProject API. A default retry strategy applies to this operation GetGenerativeAiProject()
func (client GenerativeAiClient) GetHostedApplication(ctx context.Context, request GetHostedApplicationRequest) (response GetHostedApplicationResponse, err error)
GetHostedApplication Gets information about a hosted application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetHostedApplication.go.html to see an example of how to use GetHostedApplication API. A default retry strategy applies to this operation GetHostedApplication()
func (client GenerativeAiClient) GetHostedApplicationStorage(ctx context.Context, request GetHostedApplicationStorageRequest) (response GetHostedApplicationStorageResponse, err error)
GetHostedApplicationStorage Gets information about a hosted application storage.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetHostedApplicationStorage.go.html to see an example of how to use GetHostedApplicationStorage API. A default retry strategy applies to this operation GetHostedApplicationStorage()
func (client GenerativeAiClient) GetHostedDeployment(ctx context.Context, request GetHostedDeploymentRequest) (response GetHostedDeploymentResponse, err error)
GetHostedDeployment Gets information about a hosted deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetHostedDeployment.go.html to see an example of how to use GetHostedDeployment API. A default retry strategy applies to this operation GetHostedDeployment()
func (client GenerativeAiClient) GetImportedModel(ctx context.Context, request GetImportedModelRequest) (response GetImportedModelResponse, err error)
GetImportedModel Gets information about an imported model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetImportedModel.go.html to see an example of how to use GetImportedModel API. A default retry strategy applies to this operation GetImportedModel()
func (client GenerativeAiClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)
GetModel Gets information about a custom model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetModel.go.html to see an example of how to use GetModel API. A default retry strategy applies to this operation GetModel()
func (client GenerativeAiClient) GetSemanticStore(ctx context.Context, request GetSemanticStoreRequest) (response GetSemanticStoreResponse, err error)
GetSemanticStore Gets information about a semanticStore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetSemanticStore.go.html to see an example of how to use GetSemanticStore API. A default retry strategy applies to this operation GetSemanticStore()
func (client GenerativeAiClient) GetVectorStoreConnector(ctx context.Context, request GetVectorStoreConnectorRequest) (response GetVectorStoreConnectorResponse, err error)
GetVectorStoreConnector Gets information about a vectorStoreConnector.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetVectorStoreConnector.go.html to see an example of how to use GetVectorStoreConnector API. A default retry strategy applies to this operation GetVectorStoreConnector()
func (client GenerativeAiClient) GetVectorStoreConnectorFileSync(ctx context.Context, request GetVectorStoreConnectorFileSyncRequest) (response GetVectorStoreConnectorFileSyncResponse, err error)
GetVectorStoreConnectorFileSync Gets information about a vectorStoreConnectorFileSync.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetVectorStoreConnectorFileSync.go.html to see an example of how to use GetVectorStoreConnectorFileSync API. A default retry strategy applies to this operation GetVectorStoreConnectorFileSync()
func (client GenerativeAiClient) GetVectorStoreConnectorStats(ctx context.Context, request GetVectorStoreConnectorStatsRequest) (response GetVectorStoreConnectorStatsResponse, err error)
GetVectorStoreConnectorStats Gets Sync statistics from a vectorStoreConnector.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetVectorStoreConnectorStats.go.html to see an example of how to use GetVectorStoreConnectorStats API. A default retry strategy applies to this operation GetVectorStoreConnectorStats()
func (client GenerativeAiClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client GenerativeAiClient) ListApiKeys(ctx context.Context, request ListApiKeysRequest) (response ListApiKeysResponse, err error)
ListApiKeys Lists the ApiKeys of a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListApiKeys.go.html to see an example of how to use ListApiKeys API. A default retry strategy applies to this operation ListApiKeys()
func (client GenerativeAiClient) ListDedicatedAiClusters(ctx context.Context, request ListDedicatedAiClustersRequest) (response ListDedicatedAiClustersResponse, err error)
ListDedicatedAiClusters Lists the dedicated AI clusters in a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListDedicatedAiClusters.go.html to see an example of how to use ListDedicatedAiClusters API. A default retry strategy applies to this operation ListDedicatedAiClusters()
func (client GenerativeAiClient) ListEndpoints(ctx context.Context, request ListEndpointsRequest) (response ListEndpointsResponse, err error)
ListEndpoints Lists the endpoints of a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListEndpoints.go.html to see an example of how to use ListEndpoints API. A default retry strategy applies to this operation ListEndpoints()
func (client GenerativeAiClient) ListGenerativeAiPrivateEndpoints(ctx context.Context, request ListGenerativeAiPrivateEndpointsRequest) (response ListGenerativeAiPrivateEndpointsResponse, err error)
ListGenerativeAiPrivateEndpoints Lists all Generative AI private endpoints in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListGenerativeAiPrivateEndpoints.go.html to see an example of how to use ListGenerativeAiPrivateEndpoints API. A default retry strategy applies to this operation ListGenerativeAiPrivateEndpoints()
func (client GenerativeAiClient) ListGenerativeAiProjects(ctx context.Context, request ListGenerativeAiProjectsRequest) (response ListGenerativeAiProjectsResponse, err error)
ListGenerativeAiProjects Lists the generativeAiProjects of a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListGenerativeAiProjects.go.html to see an example of how to use ListGenerativeAiProjects API. A default retry strategy applies to this operation ListGenerativeAiProjects()
func (client GenerativeAiClient) ListHostedApplicationStorages(ctx context.Context, request ListHostedApplicationStoragesRequest) (response ListHostedApplicationStoragesResponse, err error)
ListHostedApplicationStorages Lists the hosted application storage in a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListHostedApplicationStorages.go.html to see an example of how to use ListHostedApplicationStorages API. A default retry strategy applies to this operation ListHostedApplicationStorages()
func (client GenerativeAiClient) ListHostedApplications(ctx context.Context, request ListHostedApplicationsRequest) (response ListHostedApplicationsResponse, err error)
ListHostedApplications Lists the hosted applications in a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListHostedApplications.go.html to see an example of how to use ListHostedApplications API. A default retry strategy applies to this operation ListHostedApplications()
func (client GenerativeAiClient) ListHostedDeployments(ctx context.Context, request ListHostedDeploymentsRequest) (response ListHostedDeploymentsResponse, err error)
ListHostedDeployments Lists the hosted applications in a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListHostedDeployments.go.html to see an example of how to use ListHostedDeployments API. A default retry strategy applies to this operation ListHostedDeployments()
func (client GenerativeAiClient) ListImportedModels(ctx context.Context, request ListImportedModelsRequest) (response ListImportedModelsResponse, err error)
ListImportedModels Lists imported models in a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListImportedModels.go.html to see an example of how to use ListImportedModels API. A default retry strategy applies to this operation ListImportedModels()
func (client GenerativeAiClient) ListModels(ctx context.Context, request ListModelsRequest) (response ListModelsResponse, err error)
ListModels Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListModels.go.html to see an example of how to use ListModels API. A default retry strategy applies to this operation ListModels()
func (client GenerativeAiClient) ListSemanticStores(ctx context.Context, request ListSemanticStoresRequest) (response ListSemanticStoresResponse, err error)
ListSemanticStores Lists the SemanticStores given specific filter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListSemanticStores.go.html to see an example of how to use ListSemanticStores API. A default retry strategy applies to this operation ListSemanticStores()
func (client GenerativeAiClient) ListVectorStoreConnectorFileSyncIngestionLogs(ctx context.Context, request ListVectorStoreConnectorFileSyncIngestionLogsRequest) (response ListVectorStoreConnectorFileSyncIngestionLogsResponse, err error)
ListVectorStoreConnectorFileSyncIngestionLogs Gets Ingestion logs for a vectorStoreConnectorFileSync operation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectorFileSyncIngestionLogs.go.html to see an example of how to use ListVectorStoreConnectorFileSyncIngestionLogs API. A default retry strategy applies to this operation ListVectorStoreConnectorFileSyncIngestionLogs()
func (client GenerativeAiClient) ListVectorStoreConnectorFileSyncs(ctx context.Context, request ListVectorStoreConnectorFileSyncsRequest) (response ListVectorStoreConnectorFileSyncsResponse, err error)
ListVectorStoreConnectorFileSyncs Lists the vectorStoreConnectorFileSyncs of a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectorFileSyncs.go.html to see an example of how to use ListVectorStoreConnectorFileSyncs API. A default retry strategy applies to this operation ListVectorStoreConnectorFileSyncs()
func (client GenerativeAiClient) ListVectorStoreConnectorIngestionLogs(ctx context.Context, request ListVectorStoreConnectorIngestionLogsRequest) (response ListVectorStoreConnectorIngestionLogsResponse, err error)
ListVectorStoreConnectorIngestionLogs Gets Ingestion logs for a vectorStoreConnector.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectorIngestionLogs.go.html to see an example of how to use ListVectorStoreConnectorIngestionLogs API. A default retry strategy applies to this operation ListVectorStoreConnectorIngestionLogs()
func (client GenerativeAiClient) ListVectorStoreConnectors(ctx context.Context, request ListVectorStoreConnectorsRequest) (response ListVectorStoreConnectorsResponse, err error)
ListVectorStoreConnectors Lists the vectorStoreConnectors of a specific compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectors.go.html to see an example of how to use ListVectorStoreConnectors API. A default retry strategy applies to this operation ListVectorStoreConnectors()
func (client GenerativeAiClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client GenerativeAiClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client GenerativeAiClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client GenerativeAiClient) RenewApiKey(ctx context.Context, request RenewApiKeyRequest) (response RenewApiKeyResponse, err error)
RenewApiKey Renew the primary or secondary key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/RenewApiKey.go.html to see an example of how to use RenewApiKey API. A default retry strategy applies to this operation RenewApiKey()
func (client GenerativeAiClient) SetApiKeyState(ctx context.Context, request SetApiKeyStateRequest) (response SetApiKeyStateResponse, err error)
SetApiKeyState Set state of the key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/SetApiKeyState.go.html to see an example of how to use SetApiKeyState API. A default retry strategy applies to this operation SetApiKeyState()
func (client *GenerativeAiClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GenerativeAiClient) UpdateApiKey(ctx context.Context, request UpdateApiKeyRequest) (response UpdateApiKeyResponse, err error)
UpdateApiKey Updates the properties of an apiKey.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateApiKey.go.html to see an example of how to use UpdateApiKey API. A default retry strategy applies to this operation UpdateApiKey()
func (client GenerativeAiClient) UpdateDedicatedAiCluster(ctx context.Context, request UpdateDedicatedAiClusterRequest) (response UpdateDedicatedAiClusterResponse, err error)
UpdateDedicatedAiCluster Updates a dedicated AI cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateDedicatedAiCluster.go.html to see an example of how to use UpdateDedicatedAiCluster API. A default retry strategy applies to this operation UpdateDedicatedAiCluster()
func (client GenerativeAiClient) UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (response UpdateEndpointResponse, err error)
UpdateEndpoint Updates the properties of an endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateEndpoint.go.html to see an example of how to use UpdateEndpoint API. A default retry strategy applies to this operation UpdateEndpoint()
func (client GenerativeAiClient) UpdateGenerativeAiPrivateEndpoint(ctx context.Context, request UpdateGenerativeAiPrivateEndpointRequest) (response UpdateGenerativeAiPrivateEndpointResponse, err error)
UpdateGenerativeAiPrivateEndpoint Updates a Generative AI private endpoint using a `privateEndpointId`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateGenerativeAiPrivateEndpoint.go.html to see an example of how to use UpdateGenerativeAiPrivateEndpoint API. A default retry strategy applies to this operation UpdateGenerativeAiPrivateEndpoint()
func (client GenerativeAiClient) UpdateGenerativeAiProject(ctx context.Context, request UpdateGenerativeAiProjectRequest) (response UpdateGenerativeAiProjectResponse, err error)
UpdateGenerativeAiProject Updates the properties of a generativeAiProject.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateGenerativeAiProject.go.html to see an example of how to use UpdateGenerativeAiProject API. A default retry strategy applies to this operation UpdateGenerativeAiProject()
func (client GenerativeAiClient) UpdateHostedApplication(ctx context.Context, request UpdateHostedApplicationRequest) (response UpdateHostedApplicationResponse, err error)
UpdateHostedApplication Updates a hosted application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateHostedApplication.go.html to see an example of how to use UpdateHostedApplication API. A default retry strategy applies to this operation UpdateHostedApplication()
func (client GenerativeAiClient) UpdateHostedDeployment(ctx context.Context, request UpdateHostedDeploymentRequest) (response UpdateHostedDeploymentResponse, err error)
UpdateHostedDeployment Updates a hosted deployment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateHostedDeployment.go.html to see an example of how to use UpdateHostedDeployment API. A default retry strategy applies to this operation UpdateHostedDeployment()
func (client GenerativeAiClient) UpdateImportedModel(ctx context.Context, request UpdateImportedModelRequest) (response UpdateImportedModelResponse, err error)
UpdateImportedModel Updates the properties of an imported model such as name, description, freeform tags, and defined tags.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateImportedModel.go.html to see an example of how to use UpdateImportedModel API. A default retry strategy applies to this operation UpdateImportedModel()
func (client GenerativeAiClient) UpdateModel(ctx context.Context, request UpdateModelRequest) (response UpdateModelResponse, err error)
UpdateModel Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateModel.go.html to see an example of how to use UpdateModel API. A default retry strategy applies to this operation UpdateModel()
func (client GenerativeAiClient) UpdateSemanticStore(ctx context.Context, request UpdateSemanticStoreRequest) (response UpdateSemanticStoreResponse, err error)
UpdateSemanticStore Updates the properties of a SemanticStore.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateSemanticStore.go.html to see an example of how to use UpdateSemanticStore API. A default retry strategy applies to this operation UpdateSemanticStore()
func (client GenerativeAiClient) UpdateVectorStoreConnector(ctx context.Context, request UpdateVectorStoreConnectorRequest) (response UpdateVectorStoreConnectorResponse, err error)
UpdateVectorStoreConnector Updates the properties of a vectorStoreConnector.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateVectorStoreConnector.go.html to see an example of how to use UpdateVectorStoreConnector API. A default retry strategy applies to this operation UpdateVectorStoreConnector()
GenerativeAiPrivateEndpoint Generative AI private endpoint.
type GenerativeAiPrivateEndpoint struct {
// The OCID of a private endpoint.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the private endpoint.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the subnet that the private endpoint belongs to.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The current state of the Generative AI Private Endpoint.
LifecycleState GenerativeAiPrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
Fqdn *string `mandatory:"true" json:"fqdn"`
// The date and time that the Generative AI private endpoint was created expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the Generative AI private endpoint was updated expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description of this private endpoint.
Description *string `mandatory:"false" json:"description"`
// The detailed messages about the lifecycle state
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Flag that allows access to on-demand models using this private endpoint.
IsAllowOnDemand *bool `mandatory:"false" json:"isAllowOnDemand"`
// The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`
PreviousState *GenerativeAiPrivateEndpoint `mandatory:"false" json:"previousState"`
// The resource type that Generative AI private endpoint can be used for.
ResourceType GenerativeAiPrivateEndpointResourceTypeEnum `mandatory:"false" json:"resourceType,omitempty"`
// 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.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.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"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m GenerativeAiPrivateEndpoint) String() string
func (m GenerativeAiPrivateEndpoint) 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
GenerativeAiPrivateEndpointCollection Collection of GenerativeAiPrivateEndpointSummary
type GenerativeAiPrivateEndpointCollection struct {
// The results of a GenerativeAiPrivateEndpoint list.
Items []GenerativeAiPrivateEndpointSummary `mandatory:"true" json:"items"`
}
func (m GenerativeAiPrivateEndpointCollection) String() string
func (m GenerativeAiPrivateEndpointCollection) 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
GenerativeAiPrivateEndpointLifecycleStateEnum Enum with underlying type: string
type GenerativeAiPrivateEndpointLifecycleStateEnum string
Set of constants representing the allowable values for GenerativeAiPrivateEndpointLifecycleStateEnum
const (
GenerativeAiPrivateEndpointLifecycleStateCreating GenerativeAiPrivateEndpointLifecycleStateEnum = "CREATING"
GenerativeAiPrivateEndpointLifecycleStateActive GenerativeAiPrivateEndpointLifecycleStateEnum = "ACTIVE"
GenerativeAiPrivateEndpointLifecycleStateUpdating GenerativeAiPrivateEndpointLifecycleStateEnum = "UPDATING"
GenerativeAiPrivateEndpointLifecycleStateDeleting GenerativeAiPrivateEndpointLifecycleStateEnum = "DELETING"
GenerativeAiPrivateEndpointLifecycleStateDeleted GenerativeAiPrivateEndpointLifecycleStateEnum = "DELETED"
GenerativeAiPrivateEndpointLifecycleStateFailed GenerativeAiPrivateEndpointLifecycleStateEnum = "FAILED"
)
func GetGenerativeAiPrivateEndpointLifecycleStateEnumValues() []GenerativeAiPrivateEndpointLifecycleStateEnum
GetGenerativeAiPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for GenerativeAiPrivateEndpointLifecycleStateEnum
func GetMappingGenerativeAiPrivateEndpointLifecycleStateEnum(val string) (GenerativeAiPrivateEndpointLifecycleStateEnum, bool)
GetMappingGenerativeAiPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
GenerativeAiPrivateEndpointResourceTypeEnum Enum with underlying type: string
type GenerativeAiPrivateEndpointResourceTypeEnum string
Set of constants representing the allowable values for GenerativeAiPrivateEndpointResourceTypeEnum
const (
GenerativeAiPrivateEndpointResourceTypeApplication GenerativeAiPrivateEndpointResourceTypeEnum = "APPLICATION"
GenerativeAiPrivateEndpointResourceTypeEndpoint GenerativeAiPrivateEndpointResourceTypeEnum = "ENDPOINT"
)
func GetGenerativeAiPrivateEndpointResourceTypeEnumValues() []GenerativeAiPrivateEndpointResourceTypeEnum
GetGenerativeAiPrivateEndpointResourceTypeEnumValues Enumerates the set of values for GenerativeAiPrivateEndpointResourceTypeEnum
func GetMappingGenerativeAiPrivateEndpointResourceTypeEnum(val string) (GenerativeAiPrivateEndpointResourceTypeEnum, bool)
GetMappingGenerativeAiPrivateEndpointResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GenerativeAiPrivateEndpointSummary List of Generative AI private endpoints.
type GenerativeAiPrivateEndpointSummary struct {
// The OCID of a private endpoint.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the private endpoint.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of a subnet.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The current state of the Generative AI Private Endpoint.
LifecycleState GenerativeAiPrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Fully qualified domain name the customer will use for access
Fqdn *string `mandatory:"true" json:"fqdn"`
// The date and time that the Generative AI private endpoint was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the Generative AI private endpoint was updated expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A user-friendly name. It doesn't have to be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description of this private endpoint.
Description *string `mandatory:"false" json:"description"`
// Details of the state of a private endpoint.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Flag that allows access to on-demand models using this private endpoint.
IsAllowOnDemand *bool `mandatory:"false" json:"isAllowOnDemand"`
// The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`
// The resource type that Generative AI private endpoint can be used for.
ResourceType GenerativeAiPrivateEndpointResourceTypeEnum `mandatory:"false" json:"resourceType,omitempty"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// 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"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m GenerativeAiPrivateEndpointSummary) String() string
func (m GenerativeAiPrivateEndpointSummary) 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
GenerativeAiProject A GenerativeAiProject is a logical container that stores conversation, file and containers. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type GenerativeAiProject struct {
// An OCID that uniquely identifies a GenerativeAiProject.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Owning compartment OCID for a GenerativeAiProject.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the generativeAiProject was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The lifecycle state of a GenerativeAiProject.
LifecycleState GenerativeAiProjectLifecycleStateEnum `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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// An optional description of the GenerativeAiProject.
Description *string `mandatory:"false" json:"description"`
// The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
ConversationConfig *ConversationConfig `mandatory:"false" json:"conversationConfig"`
LongTermMemoryConfig *LongTermMemoryConfig `mandatory:"false" json:"longTermMemoryConfig"`
ShortTermMemoryOptimizationConfig *ShortTermMemoryOptimizationConfig `mandatory:"false" json:"shortTermMemoryOptimizationConfig"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GenerativeAiProject) String() string
func (m GenerativeAiProject) 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
GenerativeAiProjectCollection Results of a GenerativeAiProject search. Contains GenerativeAiProjectSummary items and other information such as metadata.
type GenerativeAiProjectCollection struct {
// List of GenerativeAiProjects.
Items []GenerativeAiProjectSummary `mandatory:"true" json:"items"`
}
func (m GenerativeAiProjectCollection) String() string
func (m GenerativeAiProjectCollection) 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
GenerativeAiProjectLifecycleStateEnum Enum with underlying type: string
type GenerativeAiProjectLifecycleStateEnum string
Set of constants representing the allowable values for GenerativeAiProjectLifecycleStateEnum
const (
GenerativeAiProjectLifecycleStateActive GenerativeAiProjectLifecycleStateEnum = "ACTIVE"
GenerativeAiProjectLifecycleStateCreating GenerativeAiProjectLifecycleStateEnum = "CREATING"
GenerativeAiProjectLifecycleStateUpdating GenerativeAiProjectLifecycleStateEnum = "UPDATING"
GenerativeAiProjectLifecycleStateDeleting GenerativeAiProjectLifecycleStateEnum = "DELETING"
GenerativeAiProjectLifecycleStateDeleted GenerativeAiProjectLifecycleStateEnum = "DELETED"
GenerativeAiProjectLifecycleStateFailed GenerativeAiProjectLifecycleStateEnum = "FAILED"
)
func GetGenerativeAiProjectLifecycleStateEnumValues() []GenerativeAiProjectLifecycleStateEnum
GetGenerativeAiProjectLifecycleStateEnumValues Enumerates the set of values for GenerativeAiProjectLifecycleStateEnum
func GetMappingGenerativeAiProjectLifecycleStateEnum(val string) (GenerativeAiProjectLifecycleStateEnum, bool)
GetMappingGenerativeAiProjectLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
GenerativeAiProjectSummary Summary information for a GenerativeAiProject.
type GenerativeAiProjectSummary struct {
// An OCID that uniquely identifies a GenerativeAiProject.
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"`
// Owning compartment OCID for a GenerativeAiProject.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the generativeAiProject was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the GenerativeAiProject.
// Allowed values are:
// - ACTIVE
// - CREATING
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState GenerativeAiProjectLifecycleStateEnum `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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// An optional description of the GenerativeAiProject.
Description *string `mandatory:"false" json:"description"`
// The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GenerativeAiProjectSummary) String() string
func (m GenerativeAiProjectSummary) 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
GetApiKeyRequest wrapper for the GetApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetApiKey.go.html to see an example of how to use GetApiKeyRequest.
type GetApiKeyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApiKeyRequest) String() string
func (request GetApiKeyRequest) 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
GetApiKeyResponse wrapper for the GetApiKey operation
type GetApiKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiKey instance
ApiKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApiKeyResponse) String() string
GetDedicatedAiClusterRequest wrapper for the GetDedicatedAiCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetDedicatedAiCluster.go.html to see an example of how to use GetDedicatedAiClusterRequest.
type GetDedicatedAiClusterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
DedicatedAiClusterId *string `mandatory:"true" contributesTo:"path" name:"dedicatedAiClusterId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDedicatedAiClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDedicatedAiClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDedicatedAiClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDedicatedAiClusterRequest) String() string
func (request GetDedicatedAiClusterRequest) 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
GetDedicatedAiClusterResponse wrapper for the GetDedicatedAiCluster operation
type GetDedicatedAiClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DedicatedAiCluster instance
DedicatedAiCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetDedicatedAiClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDedicatedAiClusterResponse) String() string
GetEndpointRequest wrapper for the GetEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetEndpoint.go.html to see an example of how to use GetEndpointRequest.
type GetEndpointRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEndpointRequest) String() string
func (request GetEndpointRequest) 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
GetEndpointResponse wrapper for the GetEndpoint operation
type GetEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The Endpoint instance
Endpoint `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEndpointResponse) String() string
GetGenerativeAiPrivateEndpointRequest wrapper for the GetGenerativeAiPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetGenerativeAiPrivateEndpoint.go.html to see an example of how to use GetGenerativeAiPrivateEndpointRequest.
type GetGenerativeAiPrivateEndpointRequest struct {
// The unique id for a Generative AI private endpoint.
GenerativeAiPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"generativeAiPrivateEndpointId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetGenerativeAiPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGenerativeAiPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGenerativeAiPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGenerativeAiPrivateEndpointRequest) String() string
func (request GetGenerativeAiPrivateEndpointRequest) 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
GetGenerativeAiPrivateEndpointResponse wrapper for the GetGenerativeAiPrivateEndpoint operation
type GetGenerativeAiPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerativeAiPrivateEndpoint instance
GenerativeAiPrivateEndpoint `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetGenerativeAiPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGenerativeAiPrivateEndpointResponse) String() string
GetGenerativeAiProjectRequest wrapper for the GetGenerativeAiProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetGenerativeAiProject.go.html to see an example of how to use GetGenerativeAiProjectRequest.
type GetGenerativeAiProjectRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject.
GenerativeAiProjectId *string `mandatory:"true" contributesTo:"path" name:"generativeAiProjectId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetGenerativeAiProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGenerativeAiProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGenerativeAiProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGenerativeAiProjectRequest) String() string
func (request GetGenerativeAiProjectRequest) 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
GetGenerativeAiProjectResponse wrapper for the GetGenerativeAiProject operation
type GetGenerativeAiProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerativeAiProject instance
GenerativeAiProject `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetGenerativeAiProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGenerativeAiProjectResponse) String() string
GetHostedApplicationRequest wrapper for the GetHostedApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetHostedApplication.go.html to see an example of how to use GetHostedApplicationRequest.
type GetHostedApplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
HostedApplicationId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHostedApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHostedApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHostedApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHostedApplicationRequest) String() string
func (request GetHostedApplicationRequest) 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
GetHostedApplicationResponse wrapper for the GetHostedApplication operation
type GetHostedApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedApplication instance
HostedApplication `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetHostedApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHostedApplicationResponse) String() string
GetHostedApplicationStorageRequest wrapper for the GetHostedApplicationStorage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetHostedApplicationStorage.go.html to see an example of how to use GetHostedApplicationStorageRequest.
type GetHostedApplicationStorageRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage.
HostedApplicationStorageId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationStorageId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHostedApplicationStorageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHostedApplicationStorageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHostedApplicationStorageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHostedApplicationStorageRequest) String() string
func (request GetHostedApplicationStorageRequest) 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
GetHostedApplicationStorageResponse wrapper for the GetHostedApplicationStorage operation
type GetHostedApplicationStorageResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedApplicationStorage instance
HostedApplicationStorage `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetHostedApplicationStorageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHostedApplicationStorageResponse) String() string
GetHostedDeploymentRequest wrapper for the GetHostedDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetHostedDeployment.go.html to see an example of how to use GetHostedDeploymentRequest.
type GetHostedDeploymentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
HostedDeploymentId *string `mandatory:"true" contributesTo:"path" name:"hostedDeploymentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHostedDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHostedDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHostedDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHostedDeploymentRequest) String() string
func (request GetHostedDeploymentRequest) 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
GetHostedDeploymentResponse wrapper for the GetHostedDeployment operation
type GetHostedDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedDeployment instance
HostedDeployment `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetHostedDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHostedDeploymentResponse) String() string
GetImportedModelRequest wrapper for the GetImportedModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetImportedModel.go.html to see an example of how to use GetImportedModelRequest.
type GetImportedModelRequest struct {
// The importedModel OCID
ImportedModelId *string `mandatory:"true" contributesTo:"path" name:"importedModelId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetImportedModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetImportedModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetImportedModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetImportedModelRequest) String() string
func (request GetImportedModelRequest) 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
GetImportedModelResponse wrapper for the GetImportedModel operation
type GetImportedModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportedModel instance
ImportedModel `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetImportedModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetImportedModelResponse) String() string
GetModelRequest wrapper for the GetModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetModel.go.html to see an example of how to use GetModelRequest.
type GetModelRequest struct {
// The model OCID
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetModelRequest) String() string
func (request GetModelRequest) 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
GetModelResponse wrapper for the GetModel operation
type GetModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetModelResponse) String() string
GetSemanticStoreRequest wrapper for the GetSemanticStore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetSemanticStore.go.html to see an example of how to use GetSemanticStoreRequest.
type GetSemanticStoreRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore.
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSemanticStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSemanticStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSemanticStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSemanticStoreRequest) String() string
func (request GetSemanticStoreRequest) 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
GetSemanticStoreResponse wrapper for the GetSemanticStore operation
type GetSemanticStoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The SemanticStore instance
SemanticStore `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSemanticStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSemanticStoreResponse) String() string
GetVectorStoreConnectorFileSyncRequest wrapper for the GetVectorStoreConnectorFileSync operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetVectorStoreConnectorFileSync.go.html to see an example of how to use GetVectorStoreConnectorFileSyncRequest.
type GetVectorStoreConnectorFileSyncRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync.
VectorStoreConnectorFileSyncId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorFileSyncId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVectorStoreConnectorFileSyncRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVectorStoreConnectorFileSyncRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVectorStoreConnectorFileSyncRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVectorStoreConnectorFileSyncRequest) String() string
func (request GetVectorStoreConnectorFileSyncRequest) 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
GetVectorStoreConnectorFileSyncResponse wrapper for the GetVectorStoreConnectorFileSync operation
type GetVectorStoreConnectorFileSyncResponse struct {
// The underlying http response
RawResponse *http.Response
// The VectorStoreConnectorFileSync instance
VectorStoreConnectorFileSync `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVectorStoreConnectorFileSyncResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVectorStoreConnectorFileSyncResponse) String() string
GetVectorStoreConnectorRequest wrapper for the GetVectorStoreConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetVectorStoreConnector.go.html to see an example of how to use GetVectorStoreConnectorRequest.
type GetVectorStoreConnectorRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
VectorStoreConnectorId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVectorStoreConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVectorStoreConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVectorStoreConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVectorStoreConnectorRequest) String() string
func (request GetVectorStoreConnectorRequest) 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
GetVectorStoreConnectorResponse wrapper for the GetVectorStoreConnector operation
type GetVectorStoreConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The VectorStoreConnector instance
VectorStoreConnector `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVectorStoreConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVectorStoreConnectorResponse) String() string
GetVectorStoreConnectorStatsRequest wrapper for the GetVectorStoreConnectorStats operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetVectorStoreConnectorStats.go.html to see an example of how to use GetVectorStoreConnectorStatsRequest.
type GetVectorStoreConnectorStatsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
VectorStoreConnectorId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVectorStoreConnectorStatsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVectorStoreConnectorStatsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVectorStoreConnectorStatsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVectorStoreConnectorStatsRequest) String() string
func (request GetVectorStoreConnectorStatsRequest) 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
GetVectorStoreConnectorStatsResponse wrapper for the GetVectorStoreConnectorStats operation
type GetVectorStoreConnectorStatsResponse struct {
// The underlying http response
RawResponse *http.Response
// The VectorStoreConnectorStats instance
VectorStoreConnectorStats `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVectorStoreConnectorStatsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVectorStoreConnectorStatsResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HostedApplication Hosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type HostedApplication struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
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 current state of the hosted application.
LifecycleState HostedApplicationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An optional description of the hosted application.
Description *string `mandatory:"false" json:"description"`
// The compartment OCID to create the hosted application in.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The date and time the hosted application was created, in the format defined by RFC 3339
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the hosted application was updated, in the format defined by RFC 3339
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state of the endpoint in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
ScalingConfig *ScalingConfig `mandatory:"false" json:"scalingConfig"`
// A list of storageConfigs managed by the OCI GenAI Platform and attached to the application.
StorageConfigs []StorageConfig `mandatory:"false" json:"storageConfigs"`
InboundAuthConfig *InboundAuthConfig `mandatory:"false" json:"inboundAuthConfig"`
NetworkingConfig *NetworkingConfig `mandatory:"false" json:"networkingConfig"`
// The list of environment variables for the Hosted Application.
// Defines a list of environment variables injected at runtime.
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m HostedApplication) String() string
func (m HostedApplication) 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
HostedApplicationCollection Results of a dedicate hosted application search. Contains HostedApplicationSummary items and other information such as metadata.
type HostedApplicationCollection struct {
// List of hosted applications.
Items []HostedApplicationSummary `mandatory:"true" json:"items"`
}
func (m HostedApplicationCollection) String() string
func (m HostedApplicationCollection) 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
HostedApplicationLifecycleStateEnum Enum with underlying type: string
type HostedApplicationLifecycleStateEnum string
Set of constants representing the allowable values for HostedApplicationLifecycleStateEnum
const (
HostedApplicationLifecycleStateCreating HostedApplicationLifecycleStateEnum = "CREATING"
HostedApplicationLifecycleStateActive HostedApplicationLifecycleStateEnum = "ACTIVE"
HostedApplicationLifecycleStateUpdating HostedApplicationLifecycleStateEnum = "UPDATING"
HostedApplicationLifecycleStateDeleting HostedApplicationLifecycleStateEnum = "DELETING"
HostedApplicationLifecycleStateDeleted HostedApplicationLifecycleStateEnum = "DELETED"
HostedApplicationLifecycleStateFailed HostedApplicationLifecycleStateEnum = "FAILED"
)
func GetHostedApplicationLifecycleStateEnumValues() []HostedApplicationLifecycleStateEnum
GetHostedApplicationLifecycleStateEnumValues Enumerates the set of values for HostedApplicationLifecycleStateEnum
func GetMappingHostedApplicationLifecycleStateEnum(val string) (HostedApplicationLifecycleStateEnum, bool)
GetMappingHostedApplicationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
HostedApplicationStorage defines a physical storage (database or cache) managed by service. Each application can choose one or two storages for certain purpose such as agent memory. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type HostedApplicationStorage struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage.
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 compartment OCID to create the hosted application in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// type like Cache, Postgresql and ADB.
StorageType HostedApplicationStorageStorageTypeEnum `mandatory:"true" json:"storageType"`
// The current state of the hosted application storage.
LifecycleState HostedApplicationStorageLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A list of application OCID.
ApplicationIds []string `mandatory:"true" json:"applicationIds"`
// An optional description of the hosted application storage.
Description *string `mandatory:"false" json:"description"`
// The date and time the hosted application was created, in the format defined by RFC 3339
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the hosted application was updated, in the format defined by RFC 3339
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state of the hosted application storage in more detail that can provide actionable information.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m HostedApplicationStorage) String() string
func (m HostedApplicationStorage) 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
HostedApplicationStorageCollection Results of a dedicate hosted application search. Contains HostedApplicationStorageSummary items and other information such as metadata.
type HostedApplicationStorageCollection struct {
// List of hosted application storages.
Items []HostedApplicationStorageSummary `mandatory:"true" json:"items"`
}
func (m HostedApplicationStorageCollection) String() string
func (m HostedApplicationStorageCollection) 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
HostedApplicationStorageLifecycleStateEnum Enum with underlying type: string
type HostedApplicationStorageLifecycleStateEnum string
Set of constants representing the allowable values for HostedApplicationStorageLifecycleStateEnum
const (
HostedApplicationStorageLifecycleStateCreating HostedApplicationStorageLifecycleStateEnum = "CREATING"
HostedApplicationStorageLifecycleStateActive HostedApplicationStorageLifecycleStateEnum = "ACTIVE"
HostedApplicationStorageLifecycleStateUpdating HostedApplicationStorageLifecycleStateEnum = "UPDATING"
HostedApplicationStorageLifecycleStateDeleting HostedApplicationStorageLifecycleStateEnum = "DELETING"
HostedApplicationStorageLifecycleStateDeleted HostedApplicationStorageLifecycleStateEnum = "DELETED"
HostedApplicationStorageLifecycleStateFailed HostedApplicationStorageLifecycleStateEnum = "FAILED"
)
func GetHostedApplicationStorageLifecycleStateEnumValues() []HostedApplicationStorageLifecycleStateEnum
GetHostedApplicationStorageLifecycleStateEnumValues Enumerates the set of values for HostedApplicationStorageLifecycleStateEnum
func GetMappingHostedApplicationStorageLifecycleStateEnum(val string) (HostedApplicationStorageLifecycleStateEnum, bool)
GetMappingHostedApplicationStorageLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
HostedApplicationStorageStorageTypeEnum Enum with underlying type: string
type HostedApplicationStorageStorageTypeEnum string
Set of constants representing the allowable values for HostedApplicationStorageStorageTypeEnum
const (
HostedApplicationStorageStorageTypeCache HostedApplicationStorageStorageTypeEnum = "CACHE"
HostedApplicationStorageStorageTypePostgresql HostedApplicationStorageStorageTypeEnum = "POSTGRESQL"
HostedApplicationStorageStorageTypeAdb HostedApplicationStorageStorageTypeEnum = "ADB"
)
func GetHostedApplicationStorageStorageTypeEnumValues() []HostedApplicationStorageStorageTypeEnum
GetHostedApplicationStorageStorageTypeEnumValues Enumerates the set of values for HostedApplicationStorageStorageTypeEnum
func GetMappingHostedApplicationStorageStorageTypeEnum(val string) (HostedApplicationStorageStorageTypeEnum, bool)
GetMappingHostedApplicationStorageStorageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
HostedApplicationStorageSummary Summary information about a hosted application storage.
type HostedApplicationStorageSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
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 current state of the hosted application storage.
LifecycleState HostedApplicationStorageLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An optional description of the hosted application.
Description *string `mandatory:"false" json:"description"`
// The compartment OCID to create the hosted application in.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// type like Cache, Postgresql and ADB.
StorageType HostedApplicationStorageSummaryStorageTypeEnum `mandatory:"false" json:"storageType,omitempty"`
// The date and time the hosted application was created, in the format defined by RFC 3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the hosted application was updated, in the format defined by RFC 3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m HostedApplicationStorageSummary) String() string
func (m HostedApplicationStorageSummary) 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
HostedApplicationStorageSummaryStorageTypeEnum Enum with underlying type: string
type HostedApplicationStorageSummaryStorageTypeEnum string
Set of constants representing the allowable values for HostedApplicationStorageSummaryStorageTypeEnum
const (
HostedApplicationStorageSummaryStorageTypeCache HostedApplicationStorageSummaryStorageTypeEnum = "CACHE"
HostedApplicationStorageSummaryStorageTypePostgresql HostedApplicationStorageSummaryStorageTypeEnum = "POSTGRESQL"
HostedApplicationStorageSummaryStorageTypeAdb HostedApplicationStorageSummaryStorageTypeEnum = "ADB"
)
func GetHostedApplicationStorageSummaryStorageTypeEnumValues() []HostedApplicationStorageSummaryStorageTypeEnum
GetHostedApplicationStorageSummaryStorageTypeEnumValues Enumerates the set of values for HostedApplicationStorageSummaryStorageTypeEnum
func GetMappingHostedApplicationStorageSummaryStorageTypeEnum(val string) (HostedApplicationStorageSummaryStorageTypeEnum, bool)
GetMappingHostedApplicationStorageSummaryStorageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
HostedApplicationSummary Summary information about a hosted application.
type HostedApplicationSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
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 current state of the hosted application.
// Allowed values are:
// - CREATING
// - ACTIVE
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState HostedApplicationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An optional description of the hosted application.
Description *string `mandatory:"false" json:"description"`
// The compartment OCID to create the hosted application in.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The date and time the hosted application was created, in the format defined by RFC 3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the hosted application was updated, in the format defined by RFC 3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m HostedApplicationSummary) String() string
func (m HostedApplicationSummary) 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
HostedDeployment Hosted deployment is designed to support the full spectrum of agent use cases from lightweight, employee-facing assistants and internal workflow automation, to enterprise-grade, large-scale customer-facing workloads. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type HostedDeployment struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
Id *string `mandatory:"true" json:"id"`
// The current state of the hosted deployment.
LifecycleState HostedDeploymentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
HostedApplicationId *string `mandatory:"true" json:"hostedApplicationId"`
ActiveArtifact Artifact `mandatory:"true" json:"activeArtifact"`
// array of Artifacts.
Artifacts []Artifact `mandatory:"true" json:"artifacts"`
// A user-friendly name. Does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// The compartment OCID to create the hosted application in.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The date and time the hosted deployment was created, in the format defined by RFC 3339
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the hosted deployment was updated, in the format defined by RFC 3339
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m HostedDeployment) String() string
func (m *HostedDeployment) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m HostedDeployment) 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
HostedDeploymentCollection Results of a dedicate hosted deployment search. Contains Hosted Deployment Summary items and other information such as metadata.
type HostedDeploymentCollection struct {
// List of hosted deployments.
Items []HostedDeploymentSummary `mandatory:"true" json:"items"`
}
func (m HostedDeploymentCollection) String() string
func (m HostedDeploymentCollection) 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
HostedDeploymentLifecycleStateEnum Enum with underlying type: string
type HostedDeploymentLifecycleStateEnum string
Set of constants representing the allowable values for HostedDeploymentLifecycleStateEnum
const (
HostedDeploymentLifecycleStateCreating HostedDeploymentLifecycleStateEnum = "CREATING"
HostedDeploymentLifecycleStateActive HostedDeploymentLifecycleStateEnum = "ACTIVE"
HostedDeploymentLifecycleStateInactive HostedDeploymentLifecycleStateEnum = "INACTIVE"
HostedDeploymentLifecycleStateUpdating HostedDeploymentLifecycleStateEnum = "UPDATING"
HostedDeploymentLifecycleStateDeleting HostedDeploymentLifecycleStateEnum = "DELETING"
HostedDeploymentLifecycleStateDeleted HostedDeploymentLifecycleStateEnum = "DELETED"
HostedDeploymentLifecycleStateFailed HostedDeploymentLifecycleStateEnum = "FAILED"
)
func GetHostedDeploymentLifecycleStateEnumValues() []HostedDeploymentLifecycleStateEnum
GetHostedDeploymentLifecycleStateEnumValues Enumerates the set of values for HostedDeploymentLifecycleStateEnum
func GetMappingHostedDeploymentLifecycleStateEnum(val string) (HostedDeploymentLifecycleStateEnum, bool)
GetMappingHostedDeploymentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
HostedDeploymentSummary Summary information about a hosted deployment.
type HostedDeploymentSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
Id *string `mandatory:"true" json:"id"`
// The current state of the hosted deployment.
// Allowed values are:
// - CREATING
// - ACTIVE
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState HostedDeploymentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the hosted deployment was created, in the format defined by RFC 3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the hosted deployment was updated, in the format defined by RFC 3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
HostedApplicationId *string `mandatory:"false" json:"hostedApplicationId"`
ActiveArtifact Artifact `mandatory:"false" json:"activeArtifact"`
// array of Artifacts.
Artifacts []Artifact `mandatory:"false" json:"artifacts"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m HostedDeploymentSummary) String() string
func (m *HostedDeploymentSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m HostedDeploymentSummary) 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
HuggingFaceModel Configuration for importing a model from Hugging Face. Requires the model ID and a reference to the token stored in a vault for authenticated access.
type HuggingFaceModel struct {
// The full model OCID from Hugging Face, typically in the format
// "org/model-name" (e.g., "meta-llama/Llama-2-7b").
ModelId *string `mandatory:"true" json:"modelId"`
// Hugging Face access token to authenticate requests for restricted models.
// This token will be securely stored in OCI Vault.
AccessToken *string `mandatory:"false" json:"accessToken"`
// The name of the branch in the Hugging Face repository to import the model from.
// If not specified, "main" will be used by default.
// If you provide both a branch and a commit hash, the model will be imported from the specified commit.
Branch *string `mandatory:"false" json:"branch"`
// The commit hash in the Hugging Face repository to import the model from.
// If both a branch and a commit are provided, the commit hash will be used.
Commit *string `mandatory:"false" json:"commit"`
}
func (m HuggingFaceModel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HuggingFaceModel) String() string
func (m HuggingFaceModel) 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
IdcsAuthConfig Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCS_AUTH_CONFIG. This object must be specified when inboundAuthConfigType is IDCS_AUTH_CONFIG.
type IdcsAuthConfig struct {
// Domain URL for IDCS.
DomainUrl *string `mandatory:"true" json:"domainUrl"`
// Scope for IDCS.
Scope *string `mandatory:"true" json:"scope"`
// Audience for IDCS.
Audience *string `mandatory:"false" json:"audience"`
}
func (m IdcsAuthConfig) String() string
func (m IdcsAuthConfig) 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
ImportedModel Represents a model imported into the system based on an external data source, such as Hugging Face or Object Storage. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type ImportedModel struct {
// An OCID that uniquely identifies an imported model.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID from which the model is imported.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The lifecycle state of the imported model.
LifecycleState ImportedModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
DataSource ModelDataSource `mandatory:"true" json:"dataSource"`
// The date and time that the imported model was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the imported model.
Description *string `mandatory:"false" json:"description"`
// Specifies the intended use or supported capabilities of the imported model.
Capabilities []ImportedModelCapabilityEnum `mandatory:"false" json:"capabilities,omitempty"`
// Additional information about the current state of the imported model, providing more detailed and actionable context.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The provider of the imported model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the imported model.
Version *string `mandatory:"false" json:"version"`
// The date and time that the imported model was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
PreviousState *ImportedModel `mandatory:"false" json:"previousState"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ImportedModel) String() string
func (m *ImportedModel) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ImportedModel) 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
ImportedModelCapabilityEnum Enum with underlying type: string
type ImportedModelCapabilityEnum string
Set of constants representing the allowable values for ImportedModelCapabilityEnum
const (
ImportedModelCapabilityTextToText ImportedModelCapabilityEnum = "TEXT_TO_TEXT"
ImportedModelCapabilityImageTextToText ImportedModelCapabilityEnum = "IMAGE_TEXT_TO_TEXT"
ImportedModelCapabilityEmbedding ImportedModelCapabilityEnum = "EMBEDDING"
ImportedModelCapabilityRerank ImportedModelCapabilityEnum = "RERANK"
ImportedModelCapabilityTextToImage ImportedModelCapabilityEnum = "TEXT_TO_IMAGE"
)
func GetImportedModelCapabilityEnumValues() []ImportedModelCapabilityEnum
GetImportedModelCapabilityEnumValues Enumerates the set of values for ImportedModelCapabilityEnum
func GetMappingImportedModelCapabilityEnum(val string) (ImportedModelCapabilityEnum, bool)
GetMappingImportedModelCapabilityEnum performs case Insensitive comparison on enum value and return the desired enum
ImportedModelCollection Represents the result of a list operation for imported models.
type ImportedModelCollection struct {
// Represents the result of a list operation for imported models.
Items []ImportedModelSummary `mandatory:"true" json:"items"`
}
func (m ImportedModelCollection) String() string
func (m ImportedModelCollection) 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
ImportedModelLifecycleStateEnum Enum with underlying type: string
type ImportedModelLifecycleStateEnum string
Set of constants representing the allowable values for ImportedModelLifecycleStateEnum
const (
ImportedModelLifecycleStateActive ImportedModelLifecycleStateEnum = "ACTIVE"
ImportedModelLifecycleStateCreating ImportedModelLifecycleStateEnum = "CREATING"
ImportedModelLifecycleStateUpdating ImportedModelLifecycleStateEnum = "UPDATING"
ImportedModelLifecycleStateDeleting ImportedModelLifecycleStateEnum = "DELETING"
ImportedModelLifecycleStateDeleted ImportedModelLifecycleStateEnum = "DELETED"
ImportedModelLifecycleStateFailed ImportedModelLifecycleStateEnum = "FAILED"
)
func GetImportedModelLifecycleStateEnumValues() []ImportedModelLifecycleStateEnum
GetImportedModelLifecycleStateEnumValues Enumerates the set of values for ImportedModelLifecycleStateEnum
func GetMappingImportedModelLifecycleStateEnum(val string) (ImportedModelLifecycleStateEnum, bool)
GetMappingImportedModelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ImportedModelSummary Summary of the importedModel.
type ImportedModelSummary struct {
// An OCID that uniquely identifies an imported model.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID from which the model is imported.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The lifecycle state of the imported model.
// Allowed values are:
// - ACTIVE
// - CREATING
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState ImportedModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
DataSource ModelDataSource `mandatory:"true" json:"dataSource"`
// The date and time that the imported model was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name of the imported model.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the imported model.
Description *string `mandatory:"false" json:"description"`
// Specifies the intended use or supported capabilities of the imported model.
Capabilities []ImportedModelCapabilityEnum `mandatory:"false" json:"capabilities,omitempty"`
// Additional information about the current state of the imported model, providing more detailed and actionable context.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The provider of the imported model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the imported model.
Version *string `mandatory:"false" json:"version"`
// The date and time that the imported model was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ImportedModelSummary) String() string
func (m *ImportedModelSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ImportedModelSummary) 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
InboundAuthConfig The client-side inbound authentication configuration for the Hosted Application. Defines the network access rules. When unspecified, the service applies the default inbound authentication configuration type.
type InboundAuthConfig struct {
// Inbound authentication configuration type of network access
// (IDCS_AUTH_CONFIG).
InboundAuthConfigType InboundAuthConfigInboundAuthConfigTypeEnum `mandatory:"true" json:"inboundAuthConfigType"`
IdcsConfig *IdcsAuthConfig `mandatory:"false" json:"idcsConfig"`
}
func (m InboundAuthConfig) String() string
func (m InboundAuthConfig) 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
InboundAuthConfigInboundAuthConfigTypeEnum Enum with underlying type: string
type InboundAuthConfigInboundAuthConfigTypeEnum string
Set of constants representing the allowable values for InboundAuthConfigInboundAuthConfigTypeEnum
const (
InboundAuthConfigInboundAuthConfigTypeIdcsAuthConfig InboundAuthConfigInboundAuthConfigTypeEnum = "IDCS_AUTH_CONFIG"
)
func GetInboundAuthConfigInboundAuthConfigTypeEnumValues() []InboundAuthConfigInboundAuthConfigTypeEnum
GetInboundAuthConfigInboundAuthConfigTypeEnumValues Enumerates the set of values for InboundAuthConfigInboundAuthConfigTypeEnum
func GetMappingInboundAuthConfigInboundAuthConfigTypeEnum(val string) (InboundAuthConfigInboundAuthConfigTypeEnum, bool)
GetMappingInboundAuthConfigInboundAuthConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InboundNetworkingConfig Inbound Networking configuration.
type InboundNetworkingConfig struct {
// inbounding from public or private endpoint.
EndpointMode InboundNetworkingConfigEndpointModeEnum `mandatory:"true" json:"endpointMode"`
// The [OCID] of Private Endpoint when endpointMode=Private
PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`
}
func (m InboundNetworkingConfig) String() string
func (m InboundNetworkingConfig) 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
InboundNetworkingConfigEndpointModeEnum Enum with underlying type: string
type InboundNetworkingConfigEndpointModeEnum string
Set of constants representing the allowable values for InboundNetworkingConfigEndpointModeEnum
const (
InboundNetworkingConfigEndpointModePublic InboundNetworkingConfigEndpointModeEnum = "PUBLIC"
InboundNetworkingConfigEndpointModePrivate InboundNetworkingConfigEndpointModeEnum = "PRIVATE"
)
func GetInboundNetworkingConfigEndpointModeEnumValues() []InboundNetworkingConfigEndpointModeEnum
GetInboundNetworkingConfigEndpointModeEnumValues Enumerates the set of values for InboundNetworkingConfigEndpointModeEnum
func GetMappingInboundNetworkingConfigEndpointModeEnum(val string) (InboundNetworkingConfigEndpointModeEnum, bool)
GetMappingInboundNetworkingConfigEndpointModeEnum performs case Insensitive comparison on enum value and return the desired enum
KeyDetails The data to create/renew an API key item.
type KeyDetails struct {
// The key to renew.
KeyName *string `mandatory:"true" json:"keyName"`
// The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
TimeExpiry *common.SDKTime `mandatory:"true" json:"timeExpiry"`
}
func (m KeyDetails) String() string
func (m KeyDetails) 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
ListApiKeysRequest wrapper for the ListApiKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListApiKeys.go.html to see an example of how to use ListApiKeysRequest.
type ListApiKeysRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that their lifecycle state matches the given lifecycle state.
LifecycleState ApiKeyLifecycleStateEnum `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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListApiKeysSortOrderEnum `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 ListApiKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListApiKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApiKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApiKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApiKeysRequest) String() string
func (request ListApiKeysRequest) 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
ListApiKeysResponse wrapper for the ListApiKeys operation
type ListApiKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ApiKeyCollection instances
ApiKeyCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListApiKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApiKeysResponse) String() string
ListApiKeysSortByEnum Enum with underlying type: string
type ListApiKeysSortByEnum string
Set of constants representing the allowable values for ListApiKeysSortByEnum
const (
ListApiKeysSortByDisplayname ListApiKeysSortByEnum = "displayName"
ListApiKeysSortByTimecreated ListApiKeysSortByEnum = "timeCreated"
)
func GetListApiKeysSortByEnumValues() []ListApiKeysSortByEnum
GetListApiKeysSortByEnumValues Enumerates the set of values for ListApiKeysSortByEnum
func GetMappingListApiKeysSortByEnum(val string) (ListApiKeysSortByEnum, bool)
GetMappingListApiKeysSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApiKeysSortOrderEnum Enum with underlying type: string
type ListApiKeysSortOrderEnum string
Set of constants representing the allowable values for ListApiKeysSortOrderEnum
const (
ListApiKeysSortOrderAsc ListApiKeysSortOrderEnum = "ASC"
ListApiKeysSortOrderDesc ListApiKeysSortOrderEnum = "DESC"
)
func GetListApiKeysSortOrderEnumValues() []ListApiKeysSortOrderEnum
GetListApiKeysSortOrderEnumValues Enumerates the set of values for ListApiKeysSortOrderEnum
func GetMappingListApiKeysSortOrderEnum(val string) (ListApiKeysSortOrderEnum, bool)
GetMappingListApiKeysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDedicatedAiClustersRequest wrapper for the ListDedicatedAiClusters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListDedicatedAiClusters.go.html to see an example of how to use ListDedicatedAiClustersRequest.
type ListDedicatedAiClustersRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
LifecycleState DedicatedAiClusterLifecycleStateEnum `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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListDedicatedAiClustersSortOrderEnum `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 ListDedicatedAiClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDedicatedAiClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDedicatedAiClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDedicatedAiClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDedicatedAiClustersRequest) String() string
func (request ListDedicatedAiClustersRequest) 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
ListDedicatedAiClustersResponse wrapper for the ListDedicatedAiClusters operation
type ListDedicatedAiClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DedicatedAiClusterCollection instances
DedicatedAiClusterCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDedicatedAiClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDedicatedAiClustersResponse) String() string
ListDedicatedAiClustersSortByEnum Enum with underlying type: string
type ListDedicatedAiClustersSortByEnum string
Set of constants representing the allowable values for ListDedicatedAiClustersSortByEnum
const (
ListDedicatedAiClustersSortByTimecreated ListDedicatedAiClustersSortByEnum = "timeCreated"
ListDedicatedAiClustersSortByDisplayname ListDedicatedAiClustersSortByEnum = "displayName"
ListDedicatedAiClustersSortByLifecyclestate ListDedicatedAiClustersSortByEnum = "lifecycleState"
)
func GetListDedicatedAiClustersSortByEnumValues() []ListDedicatedAiClustersSortByEnum
GetListDedicatedAiClustersSortByEnumValues Enumerates the set of values for ListDedicatedAiClustersSortByEnum
func GetMappingListDedicatedAiClustersSortByEnum(val string) (ListDedicatedAiClustersSortByEnum, bool)
GetMappingListDedicatedAiClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDedicatedAiClustersSortOrderEnum Enum with underlying type: string
type ListDedicatedAiClustersSortOrderEnum string
Set of constants representing the allowable values for ListDedicatedAiClustersSortOrderEnum
const (
ListDedicatedAiClustersSortOrderAsc ListDedicatedAiClustersSortOrderEnum = "ASC"
ListDedicatedAiClustersSortOrderDesc ListDedicatedAiClustersSortOrderEnum = "DESC"
)
func GetListDedicatedAiClustersSortOrderEnumValues() []ListDedicatedAiClustersSortOrderEnum
GetListDedicatedAiClustersSortOrderEnumValues Enumerates the set of values for ListDedicatedAiClustersSortOrderEnum
func GetMappingListDedicatedAiClustersSortOrderEnum(val string) (ListDedicatedAiClustersSortOrderEnum, bool)
GetMappingListDedicatedAiClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEndpointsRequest wrapper for the ListEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListEndpoints.go.html to see an example of how to use ListEndpointsRequest.
type ListEndpointsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that their lifecycle state matches the given lifecycle state.
LifecycleState EndpointLifecycleStateEnum `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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
GenerativeAiPrivateEndpointId *string `mandatory:"false" contributesTo:"query" name:"generativeAiPrivateEndpointId"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListEndpointsSortOrderEnum `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 ListEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEndpointsRequest) String() string
func (request ListEndpointsRequest) 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
ListEndpointsResponse wrapper for the ListEndpoints operation
type ListEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EndpointCollection instances
EndpointCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEndpointsResponse) String() string
ListEndpointsSortByEnum Enum with underlying type: string
type ListEndpointsSortByEnum string
Set of constants representing the allowable values for ListEndpointsSortByEnum
const (
ListEndpointsSortByDisplayname ListEndpointsSortByEnum = "displayName"
ListEndpointsSortByTimecreated ListEndpointsSortByEnum = "timeCreated"
)
func GetListEndpointsSortByEnumValues() []ListEndpointsSortByEnum
GetListEndpointsSortByEnumValues Enumerates the set of values for ListEndpointsSortByEnum
func GetMappingListEndpointsSortByEnum(val string) (ListEndpointsSortByEnum, bool)
GetMappingListEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEndpointsSortOrderEnum Enum with underlying type: string
type ListEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListEndpointsSortOrderEnum
const (
ListEndpointsSortOrderAsc ListEndpointsSortOrderEnum = "ASC"
ListEndpointsSortOrderDesc ListEndpointsSortOrderEnum = "DESC"
)
func GetListEndpointsSortOrderEnumValues() []ListEndpointsSortOrderEnum
GetListEndpointsSortOrderEnumValues Enumerates the set of values for ListEndpointsSortOrderEnum
func GetMappingListEndpointsSortOrderEnum(val string) (ListEndpointsSortOrderEnum, bool)
GetMappingListEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGenerativeAiPrivateEndpointsRequest wrapper for the ListGenerativeAiPrivateEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListGenerativeAiPrivateEndpoints.go.html to see an example of how to use ListGenerativeAiPrivateEndpointsRequest.
type ListGenerativeAiPrivateEndpointsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The lifecycle state of Generative AI private endpoints.
LifecycleState GenerativeAiPrivateEndpointLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field used to sort the results. Multiple fields aren't supported.
SortBy ListGenerativeAiPrivateEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Query by the resource type of Generative AI private endpoints.
ResourceType GenerativeAiPrivateEndpointResourceTypeEnum `mandatory:"false" contributesTo:"query" name:"resourceType" 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGenerativeAiPrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListGenerativeAiPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGenerativeAiPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGenerativeAiPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGenerativeAiPrivateEndpointsRequest) String() string
func (request ListGenerativeAiPrivateEndpointsRequest) 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
ListGenerativeAiPrivateEndpointsResponse wrapper for the ListGenerativeAiPrivateEndpoints operation
type ListGenerativeAiPrivateEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GenerativeAiPrivateEndpointCollection instances
GenerativeAiPrivateEndpointCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListGenerativeAiPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGenerativeAiPrivateEndpointsResponse) String() string
ListGenerativeAiPrivateEndpointsSortByEnum Enum with underlying type: string
type ListGenerativeAiPrivateEndpointsSortByEnum string
Set of constants representing the allowable values for ListGenerativeAiPrivateEndpointsSortByEnum
const (
ListGenerativeAiPrivateEndpointsSortByTimecreated ListGenerativeAiPrivateEndpointsSortByEnum = "timeCreated"
)
func GetListGenerativeAiPrivateEndpointsSortByEnumValues() []ListGenerativeAiPrivateEndpointsSortByEnum
GetListGenerativeAiPrivateEndpointsSortByEnumValues Enumerates the set of values for ListGenerativeAiPrivateEndpointsSortByEnum
func GetMappingListGenerativeAiPrivateEndpointsSortByEnum(val string) (ListGenerativeAiPrivateEndpointsSortByEnum, bool)
GetMappingListGenerativeAiPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGenerativeAiPrivateEndpointsSortOrderEnum Enum with underlying type: string
type ListGenerativeAiPrivateEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListGenerativeAiPrivateEndpointsSortOrderEnum
const (
ListGenerativeAiPrivateEndpointsSortOrderAsc ListGenerativeAiPrivateEndpointsSortOrderEnum = "ASC"
ListGenerativeAiPrivateEndpointsSortOrderDesc ListGenerativeAiPrivateEndpointsSortOrderEnum = "DESC"
)
func GetListGenerativeAiPrivateEndpointsSortOrderEnumValues() []ListGenerativeAiPrivateEndpointsSortOrderEnum
GetListGenerativeAiPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListGenerativeAiPrivateEndpointsSortOrderEnum
func GetMappingListGenerativeAiPrivateEndpointsSortOrderEnum(val string) (ListGenerativeAiPrivateEndpointsSortOrderEnum, bool)
GetMappingListGenerativeAiPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGenerativeAiProjectsRequest wrapper for the ListGenerativeAiProjects operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListGenerativeAiProjects.go.html to see an example of how to use ListGenerativeAiProjectsRequest.
type ListGenerativeAiProjectsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources whose lifecycle state matches the given value.
LifecycleState GenerativeAiProjectLifecycleStateEnum `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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGenerativeAiProjectsSortOrderEnum `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 ListGenerativeAiProjectsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListGenerativeAiProjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGenerativeAiProjectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGenerativeAiProjectsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGenerativeAiProjectsRequest) String() string
func (request ListGenerativeAiProjectsRequest) 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
ListGenerativeAiProjectsResponse wrapper for the ListGenerativeAiProjects operation
type ListGenerativeAiProjectsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GenerativeAiProjectCollection instances
GenerativeAiProjectCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListGenerativeAiProjectsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGenerativeAiProjectsResponse) String() string
ListGenerativeAiProjectsSortByEnum Enum with underlying type: string
type ListGenerativeAiProjectsSortByEnum string
Set of constants representing the allowable values for ListGenerativeAiProjectsSortByEnum
const (
ListGenerativeAiProjectsSortByDisplayname ListGenerativeAiProjectsSortByEnum = "displayName"
ListGenerativeAiProjectsSortByTimecreated ListGenerativeAiProjectsSortByEnum = "timeCreated"
)
func GetListGenerativeAiProjectsSortByEnumValues() []ListGenerativeAiProjectsSortByEnum
GetListGenerativeAiProjectsSortByEnumValues Enumerates the set of values for ListGenerativeAiProjectsSortByEnum
func GetMappingListGenerativeAiProjectsSortByEnum(val string) (ListGenerativeAiProjectsSortByEnum, bool)
GetMappingListGenerativeAiProjectsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGenerativeAiProjectsSortOrderEnum Enum with underlying type: string
type ListGenerativeAiProjectsSortOrderEnum string
Set of constants representing the allowable values for ListGenerativeAiProjectsSortOrderEnum
const (
ListGenerativeAiProjectsSortOrderAsc ListGenerativeAiProjectsSortOrderEnum = "ASC"
ListGenerativeAiProjectsSortOrderDesc ListGenerativeAiProjectsSortOrderEnum = "DESC"
)
func GetListGenerativeAiProjectsSortOrderEnumValues() []ListGenerativeAiProjectsSortOrderEnum
GetListGenerativeAiProjectsSortOrderEnumValues Enumerates the set of values for ListGenerativeAiProjectsSortOrderEnum
func GetMappingListGenerativeAiProjectsSortOrderEnum(val string) (ListGenerativeAiProjectsSortOrderEnum, bool)
GetMappingListGenerativeAiProjectsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHostedApplicationStoragesRequest wrapper for the ListHostedApplicationStorages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListHostedApplicationStorages.go.html to see an example of how to use ListHostedApplicationStoragesRequest.
type ListHostedApplicationStoragesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state.
LifecycleState HostedApplicationStorageLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The type of the hosted application storage.
HostedApplicationStorageType HostedApplicationStorageStorageTypeEnum `mandatory:"false" contributesTo:"query" name:"hostedApplicationStorageType" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListHostedApplicationStoragesSortOrderEnum `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 ListHostedApplicationStoragesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListHostedApplicationStoragesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHostedApplicationStoragesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHostedApplicationStoragesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHostedApplicationStoragesRequest) String() string
func (request ListHostedApplicationStoragesRequest) 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
ListHostedApplicationStoragesResponse wrapper for the ListHostedApplicationStorages operation
type ListHostedApplicationStoragesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of HostedApplicationStorageCollection instances
HostedApplicationStorageCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListHostedApplicationStoragesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHostedApplicationStoragesResponse) String() string
ListHostedApplicationStoragesSortByEnum Enum with underlying type: string
type ListHostedApplicationStoragesSortByEnum string
Set of constants representing the allowable values for ListHostedApplicationStoragesSortByEnum
const (
ListHostedApplicationStoragesSortByTimecreated ListHostedApplicationStoragesSortByEnum = "timeCreated"
ListHostedApplicationStoragesSortByDisplayname ListHostedApplicationStoragesSortByEnum = "displayName"
ListHostedApplicationStoragesSortByLifecyclestate ListHostedApplicationStoragesSortByEnum = "lifecycleState"
)
func GetListHostedApplicationStoragesSortByEnumValues() []ListHostedApplicationStoragesSortByEnum
GetListHostedApplicationStoragesSortByEnumValues Enumerates the set of values for ListHostedApplicationStoragesSortByEnum
func GetMappingListHostedApplicationStoragesSortByEnum(val string) (ListHostedApplicationStoragesSortByEnum, bool)
GetMappingListHostedApplicationStoragesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHostedApplicationStoragesSortOrderEnum Enum with underlying type: string
type ListHostedApplicationStoragesSortOrderEnum string
Set of constants representing the allowable values for ListHostedApplicationStoragesSortOrderEnum
const (
ListHostedApplicationStoragesSortOrderAsc ListHostedApplicationStoragesSortOrderEnum = "ASC"
ListHostedApplicationStoragesSortOrderDesc ListHostedApplicationStoragesSortOrderEnum = "DESC"
)
func GetListHostedApplicationStoragesSortOrderEnumValues() []ListHostedApplicationStoragesSortOrderEnum
GetListHostedApplicationStoragesSortOrderEnumValues Enumerates the set of values for ListHostedApplicationStoragesSortOrderEnum
func GetMappingListHostedApplicationStoragesSortOrderEnum(val string) (ListHostedApplicationStoragesSortOrderEnum, bool)
GetMappingListHostedApplicationStoragesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHostedApplicationsRequest wrapper for the ListHostedApplications operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListHostedApplications.go.html to see an example of how to use ListHostedApplicationsRequest.
type ListHostedApplicationsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state.
LifecycleState HostedApplicationLifecycleStateEnum `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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListHostedApplicationsSortOrderEnum `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 ListHostedApplicationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListHostedApplicationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHostedApplicationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHostedApplicationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHostedApplicationsRequest) String() string
func (request ListHostedApplicationsRequest) 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
ListHostedApplicationsResponse wrapper for the ListHostedApplications operation
type ListHostedApplicationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of HostedApplicationCollection instances
HostedApplicationCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListHostedApplicationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHostedApplicationsResponse) String() string
ListHostedApplicationsSortByEnum Enum with underlying type: string
type ListHostedApplicationsSortByEnum string
Set of constants representing the allowable values for ListHostedApplicationsSortByEnum
const (
ListHostedApplicationsSortByTimecreated ListHostedApplicationsSortByEnum = "timeCreated"
ListHostedApplicationsSortByDisplayname ListHostedApplicationsSortByEnum = "displayName"
ListHostedApplicationsSortByLifecyclestate ListHostedApplicationsSortByEnum = "lifecycleState"
)
func GetListHostedApplicationsSortByEnumValues() []ListHostedApplicationsSortByEnum
GetListHostedApplicationsSortByEnumValues Enumerates the set of values for ListHostedApplicationsSortByEnum
func GetMappingListHostedApplicationsSortByEnum(val string) (ListHostedApplicationsSortByEnum, bool)
GetMappingListHostedApplicationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHostedApplicationsSortOrderEnum Enum with underlying type: string
type ListHostedApplicationsSortOrderEnum string
Set of constants representing the allowable values for ListHostedApplicationsSortOrderEnum
const (
ListHostedApplicationsSortOrderAsc ListHostedApplicationsSortOrderEnum = "ASC"
ListHostedApplicationsSortOrderDesc ListHostedApplicationsSortOrderEnum = "DESC"
)
func GetListHostedApplicationsSortOrderEnumValues() []ListHostedApplicationsSortOrderEnum
GetListHostedApplicationsSortOrderEnumValues Enumerates the set of values for ListHostedApplicationsSortOrderEnum
func GetMappingListHostedApplicationsSortOrderEnum(val string) (ListHostedApplicationsSortOrderEnum, bool)
GetMappingListHostedApplicationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHostedDeploymentsRequest wrapper for the ListHostedDeployments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListHostedDeployments.go.html to see an example of how to use ListHostedDeploymentsRequest.
type ListHostedDeploymentsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
ApplicationId *string `mandatory:"false" contributesTo:"query" name:"applicationId"`
// A filter to return only the hosted deployments that their lifecycle state matches the given lifecycle state.
LifecycleState HostedDeploymentLifecycleStateEnum `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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListHostedDeploymentsSortOrderEnum `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 ListHostedDeploymentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListHostedDeploymentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHostedDeploymentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHostedDeploymentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHostedDeploymentsRequest) String() string
func (request ListHostedDeploymentsRequest) 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
ListHostedDeploymentsResponse wrapper for the ListHostedDeployments operation
type ListHostedDeploymentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of HostedDeploymentCollection instances
HostedDeploymentCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListHostedDeploymentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHostedDeploymentsResponse) String() string
ListHostedDeploymentsSortByEnum Enum with underlying type: string
type ListHostedDeploymentsSortByEnum string
Set of constants representing the allowable values for ListHostedDeploymentsSortByEnum
const (
ListHostedDeploymentsSortByTimecreated ListHostedDeploymentsSortByEnum = "timeCreated"
ListHostedDeploymentsSortByDisplayname ListHostedDeploymentsSortByEnum = "displayName"
ListHostedDeploymentsSortByLifecyclestate ListHostedDeploymentsSortByEnum = "lifecycleState"
)
func GetListHostedDeploymentsSortByEnumValues() []ListHostedDeploymentsSortByEnum
GetListHostedDeploymentsSortByEnumValues Enumerates the set of values for ListHostedDeploymentsSortByEnum
func GetMappingListHostedDeploymentsSortByEnum(val string) (ListHostedDeploymentsSortByEnum, bool)
GetMappingListHostedDeploymentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHostedDeploymentsSortOrderEnum Enum with underlying type: string
type ListHostedDeploymentsSortOrderEnum string
Set of constants representing the allowable values for ListHostedDeploymentsSortOrderEnum
const (
ListHostedDeploymentsSortOrderAsc ListHostedDeploymentsSortOrderEnum = "ASC"
ListHostedDeploymentsSortOrderDesc ListHostedDeploymentsSortOrderEnum = "DESC"
)
func GetListHostedDeploymentsSortOrderEnumValues() []ListHostedDeploymentsSortOrderEnum
GetListHostedDeploymentsSortOrderEnumValues Enumerates the set of values for ListHostedDeploymentsSortOrderEnum
func GetMappingListHostedDeploymentsSortOrderEnum(val string) (ListHostedDeploymentsSortOrderEnum, bool)
GetMappingListHostedDeploymentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListImportedModelsRequest wrapper for the ListImportedModels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListImportedModels.go.html to see an example of how to use ListImportedModelsRequest.
type ListImportedModelsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 filter to return only resources that match the entire vendor given.
Vendor *string `mandatory:"false" contributesTo:"query" name:"vendor"`
// A filter to return only resources their capability matches the given capability.
Capability []ImportedModelCapabilityEnum `contributesTo:"query" name:"capability" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ImportedModelLifecycleStateEnum `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"`
// The ID of the importedModel.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListImportedModelsSortOrderEnum `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.
SortBy ListImportedModelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListImportedModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListImportedModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListImportedModelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListImportedModelsRequest) String() string
func (request ListImportedModelsRequest) 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
ListImportedModelsResponse wrapper for the ListImportedModels operation
type ListImportedModelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ImportedModelCollection instances
ImportedModelCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListImportedModelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListImportedModelsResponse) String() string
ListImportedModelsSortByEnum Enum with underlying type: string
type ListImportedModelsSortByEnum string
Set of constants representing the allowable values for ListImportedModelsSortByEnum
const (
ListImportedModelsSortByDisplayname ListImportedModelsSortByEnum = "displayName"
ListImportedModelsSortByLifecyclestate ListImportedModelsSortByEnum = "lifecycleState"
ListImportedModelsSortByTimecreated ListImportedModelsSortByEnum = "timeCreated"
)
func GetListImportedModelsSortByEnumValues() []ListImportedModelsSortByEnum
GetListImportedModelsSortByEnumValues Enumerates the set of values for ListImportedModelsSortByEnum
func GetMappingListImportedModelsSortByEnum(val string) (ListImportedModelsSortByEnum, bool)
GetMappingListImportedModelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListImportedModelsSortOrderEnum Enum with underlying type: string
type ListImportedModelsSortOrderEnum string
Set of constants representing the allowable values for ListImportedModelsSortOrderEnum
const (
ListImportedModelsSortOrderAsc ListImportedModelsSortOrderEnum = "ASC"
ListImportedModelsSortOrderDesc ListImportedModelsSortOrderEnum = "DESC"
)
func GetListImportedModelsSortOrderEnumValues() []ListImportedModelsSortOrderEnum
GetListImportedModelsSortOrderEnumValues Enumerates the set of values for ListImportedModelsSortOrderEnum
func GetMappingListImportedModelsSortOrderEnum(val string) (ListImportedModelsSortOrderEnum, bool)
GetMappingListImportedModelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListModelsRequest wrapper for the ListModels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListModels.go.html to see an example of how to use ListModelsRequest.
type ListModelsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 filter to return only resources that match the entire vendor given.
Vendor *string `mandatory:"false" contributesTo:"query" name:"vendor"`
// A filter to return only resources their capability matches the given capability.
Capability []ModelCapabilityEnum `contributesTo:"query" name:"capability" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ModelLifecycleStateEnum `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"`
// The ID of the model.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListModelsSortOrderEnum `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.
SortBy ListModelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListModelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListModelsRequest) String() string
func (request ListModelsRequest) 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
ListModelsResponse wrapper for the ListModels operation
type ListModelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ModelCollection instances
ModelCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListModelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListModelsResponse) String() string
ListModelsSortByEnum Enum with underlying type: string
type ListModelsSortByEnum string
Set of constants representing the allowable values for ListModelsSortByEnum
const (
ListModelsSortByDisplayname ListModelsSortByEnum = "displayName"
ListModelsSortByLifecyclestate ListModelsSortByEnum = "lifecycleState"
ListModelsSortByTimecreated ListModelsSortByEnum = "timeCreated"
)
func GetListModelsSortByEnumValues() []ListModelsSortByEnum
GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum
func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)
GetMappingListModelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListModelsSortOrderEnum Enum with underlying type: string
type ListModelsSortOrderEnum string
Set of constants representing the allowable values for ListModelsSortOrderEnum
const (
ListModelsSortOrderAsc ListModelsSortOrderEnum = "ASC"
ListModelsSortOrderDesc ListModelsSortOrderEnum = "DESC"
)
func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum
GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum
func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)
GetMappingListModelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSemanticStoresLifecycleStateEnum Enum with underlying type: string
type ListSemanticStoresLifecycleStateEnum string
Set of constants representing the allowable values for ListSemanticStoresLifecycleStateEnum
const (
ListSemanticStoresLifecycleStateActive ListSemanticStoresLifecycleStateEnum = "ACTIVE"
ListSemanticStoresLifecycleStateCreating ListSemanticStoresLifecycleStateEnum = "CREATING"
ListSemanticStoresLifecycleStateUpdating ListSemanticStoresLifecycleStateEnum = "UPDATING"
ListSemanticStoresLifecycleStateDeleting ListSemanticStoresLifecycleStateEnum = "DELETING"
ListSemanticStoresLifecycleStateDeleted ListSemanticStoresLifecycleStateEnum = "DELETED"
ListSemanticStoresLifecycleStateFailed ListSemanticStoresLifecycleStateEnum = "FAILED"
)
func GetListSemanticStoresLifecycleStateEnumValues() []ListSemanticStoresLifecycleStateEnum
GetListSemanticStoresLifecycleStateEnumValues Enumerates the set of values for ListSemanticStoresLifecycleStateEnum
func GetMappingListSemanticStoresLifecycleStateEnum(val string) (ListSemanticStoresLifecycleStateEnum, bool)
GetMappingListSemanticStoresLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSemanticStoresRequest wrapper for the ListSemanticStores operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListSemanticStores.go.html to see an example of how to use ListSemanticStoresRequest.
type ListSemanticStoresRequest struct {
// The OCID (https://docs.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 whose lifecycle state matches the given array.
LifecycleState []ListSemanticStoresLifecycleStateEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListSemanticStoresSortOrderEnum `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 ListSemanticStoresSortByEnum `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"`
// A filter to return only resources whose queryingConnectionId matches with this id.
DataSourceQueryingConnectionId *string `mandatory:"false" contributesTo:"query" name:"dataSourceQueryingConnectionId"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSemanticStoresRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSemanticStoresRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSemanticStoresRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSemanticStoresRequest) String() string
func (request ListSemanticStoresRequest) 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
ListSemanticStoresResponse wrapper for the ListSemanticStores operation
type ListSemanticStoresResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SemanticStoreCollection instances
SemanticStoreCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSemanticStoresResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSemanticStoresResponse) String() string
ListSemanticStoresSortByEnum Enum with underlying type: string
type ListSemanticStoresSortByEnum string
Set of constants representing the allowable values for ListSemanticStoresSortByEnum
const (
ListSemanticStoresSortByDisplayname ListSemanticStoresSortByEnum = "displayName"
ListSemanticStoresSortByTimecreated ListSemanticStoresSortByEnum = "timeCreated"
)
func GetListSemanticStoresSortByEnumValues() []ListSemanticStoresSortByEnum
GetListSemanticStoresSortByEnumValues Enumerates the set of values for ListSemanticStoresSortByEnum
func GetMappingListSemanticStoresSortByEnum(val string) (ListSemanticStoresSortByEnum, bool)
GetMappingListSemanticStoresSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSemanticStoresSortOrderEnum Enum with underlying type: string
type ListSemanticStoresSortOrderEnum string
Set of constants representing the allowable values for ListSemanticStoresSortOrderEnum
const (
ListSemanticStoresSortOrderAsc ListSemanticStoresSortOrderEnum = "ASC"
ListSemanticStoresSortOrderDesc ListSemanticStoresSortOrderEnum = "DESC"
)
func GetListSemanticStoresSortOrderEnumValues() []ListSemanticStoresSortOrderEnum
GetListSemanticStoresSortOrderEnumValues Enumerates the set of values for ListSemanticStoresSortOrderEnum
func GetMappingListSemanticStoresSortOrderEnum(val string) (ListSemanticStoresSortOrderEnum, bool)
GetMappingListSemanticStoresSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorFileSyncIngestionLogsRequest wrapper for the ListVectorStoreConnectorFileSyncIngestionLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectorFileSyncIngestionLogs.go.html to see an example of how to use ListVectorStoreConnectorFileSyncIngestionLogsRequest.
type ListVectorStoreConnectorFileSyncIngestionLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync.
VectorStoreConnectorFileSyncId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorFileSyncId"`
// A filter to return only resources whose lifecycle state matches the given value
LifecycleState VectorStoreConnectorFileSyncLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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"`
// The field to sort by. You can provide only one sort order. Default order for `status` is ascending.
SortBy ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVectorStoreConnectorFileSyncIngestionLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVectorStoreConnectorFileSyncIngestionLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVectorStoreConnectorFileSyncIngestionLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVectorStoreConnectorFileSyncIngestionLogsRequest) String() string
func (request ListVectorStoreConnectorFileSyncIngestionLogsRequest) 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
ListVectorStoreConnectorFileSyncIngestionLogsResponse wrapper for the ListVectorStoreConnectorFileSyncIngestionLogs operation
type ListVectorStoreConnectorFileSyncIngestionLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of FileSyncIngestionLogsCollection instances
FileSyncIngestionLogsCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListVectorStoreConnectorFileSyncIngestionLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVectorStoreConnectorFileSyncIngestionLogsResponse) String() string
ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum Enum with underlying type: string
type ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum
const (
ListVectorStoreConnectorFileSyncIngestionLogsSortByStatus ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum = "status"
ListVectorStoreConnectorFileSyncIngestionLogsSortByFilesize ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum = "fileSize"
ListVectorStoreConnectorFileSyncIngestionLogsSortByFilepath ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum = "filePath"
)
func GetListVectorStoreConnectorFileSyncIngestionLogsSortByEnumValues() []ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum
GetListVectorStoreConnectorFileSyncIngestionLogsSortByEnumValues Enumerates the set of values for ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum
func GetMappingListVectorStoreConnectorFileSyncIngestionLogsSortByEnum(val string) (ListVectorStoreConnectorFileSyncIngestionLogsSortByEnum, bool)
GetMappingListVectorStoreConnectorFileSyncIngestionLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum Enum with underlying type: string
type ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum
const (
ListVectorStoreConnectorFileSyncIngestionLogsSortOrderAsc ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum = "ASC"
ListVectorStoreConnectorFileSyncIngestionLogsSortOrderDesc ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum = "DESC"
)
func GetListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnumValues() []ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum
GetListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnumValues Enumerates the set of values for ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum
func GetMappingListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum(val string) (ListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum, bool)
GetMappingListVectorStoreConnectorFileSyncIngestionLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorFileSyncsRequest wrapper for the ListVectorStoreConnectorFileSyncs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectorFileSyncs.go.html to see an example of how to use ListVectorStoreConnectorFileSyncsRequest.
type ListVectorStoreConnectorFileSyncsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources whose lifecycle state matches the given value
LifecycleState VectorStoreConnectorFileSyncLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vectorStoreConnectorFileSync.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
VectorStoreConnectorId *string `mandatory:"false" contributesTo:"query" name:"vectorStoreConnectorId"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListVectorStoreConnectorFileSyncsSortOrderEnum `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 ListVectorStoreConnectorFileSyncsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVectorStoreConnectorFileSyncsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVectorStoreConnectorFileSyncsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVectorStoreConnectorFileSyncsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVectorStoreConnectorFileSyncsRequest) String() string
func (request ListVectorStoreConnectorFileSyncsRequest) 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
ListVectorStoreConnectorFileSyncsResponse wrapper for the ListVectorStoreConnectorFileSyncs operation
type ListVectorStoreConnectorFileSyncsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of VectorStoreConnectorFileSyncCollection instances
VectorStoreConnectorFileSyncCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListVectorStoreConnectorFileSyncsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVectorStoreConnectorFileSyncsResponse) String() string
ListVectorStoreConnectorFileSyncsSortByEnum Enum with underlying type: string
type ListVectorStoreConnectorFileSyncsSortByEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorFileSyncsSortByEnum
const (
ListVectorStoreConnectorFileSyncsSortByDisplayname ListVectorStoreConnectorFileSyncsSortByEnum = "displayName"
ListVectorStoreConnectorFileSyncsSortByTimecreated ListVectorStoreConnectorFileSyncsSortByEnum = "timeCreated"
)
func GetListVectorStoreConnectorFileSyncsSortByEnumValues() []ListVectorStoreConnectorFileSyncsSortByEnum
GetListVectorStoreConnectorFileSyncsSortByEnumValues Enumerates the set of values for ListVectorStoreConnectorFileSyncsSortByEnum
func GetMappingListVectorStoreConnectorFileSyncsSortByEnum(val string) (ListVectorStoreConnectorFileSyncsSortByEnum, bool)
GetMappingListVectorStoreConnectorFileSyncsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorFileSyncsSortOrderEnum Enum with underlying type: string
type ListVectorStoreConnectorFileSyncsSortOrderEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorFileSyncsSortOrderEnum
const (
ListVectorStoreConnectorFileSyncsSortOrderAsc ListVectorStoreConnectorFileSyncsSortOrderEnum = "ASC"
ListVectorStoreConnectorFileSyncsSortOrderDesc ListVectorStoreConnectorFileSyncsSortOrderEnum = "DESC"
)
func GetListVectorStoreConnectorFileSyncsSortOrderEnumValues() []ListVectorStoreConnectorFileSyncsSortOrderEnum
GetListVectorStoreConnectorFileSyncsSortOrderEnumValues Enumerates the set of values for ListVectorStoreConnectorFileSyncsSortOrderEnum
func GetMappingListVectorStoreConnectorFileSyncsSortOrderEnum(val string) (ListVectorStoreConnectorFileSyncsSortOrderEnum, bool)
GetMappingListVectorStoreConnectorFileSyncsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorIngestionLogsRequest wrapper for the ListVectorStoreConnectorIngestionLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectorIngestionLogs.go.html to see an example of how to use ListVectorStoreConnectorIngestionLogsRequest.
type ListVectorStoreConnectorIngestionLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
VectorStoreConnectorId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorId"`
// A filter to return only the Sync Logs whose status matches the given value.
Status VectorStoreConnectorIngestionLogsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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"`
// The field to sort by. You can provide only one sort order. Default order for `status` is ascending.
SortBy ListVectorStoreConnectorIngestionLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListVectorStoreConnectorIngestionLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVectorStoreConnectorIngestionLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVectorStoreConnectorIngestionLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVectorStoreConnectorIngestionLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVectorStoreConnectorIngestionLogsRequest) String() string
func (request ListVectorStoreConnectorIngestionLogsRequest) 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
ListVectorStoreConnectorIngestionLogsResponse wrapper for the ListVectorStoreConnectorIngestionLogs operation
type ListVectorStoreConnectorIngestionLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of VectorStoreConnectorIngestionLogsCollection instances
VectorStoreConnectorIngestionLogsCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListVectorStoreConnectorIngestionLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVectorStoreConnectorIngestionLogsResponse) String() string
ListVectorStoreConnectorIngestionLogsSortByEnum Enum with underlying type: string
type ListVectorStoreConnectorIngestionLogsSortByEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorIngestionLogsSortByEnum
const (
ListVectorStoreConnectorIngestionLogsSortByStatus ListVectorStoreConnectorIngestionLogsSortByEnum = "status"
ListVectorStoreConnectorIngestionLogsSortByFilesize ListVectorStoreConnectorIngestionLogsSortByEnum = "fileSize"
ListVectorStoreConnectorIngestionLogsSortByFilepath ListVectorStoreConnectorIngestionLogsSortByEnum = "filePath"
)
func GetListVectorStoreConnectorIngestionLogsSortByEnumValues() []ListVectorStoreConnectorIngestionLogsSortByEnum
GetListVectorStoreConnectorIngestionLogsSortByEnumValues Enumerates the set of values for ListVectorStoreConnectorIngestionLogsSortByEnum
func GetMappingListVectorStoreConnectorIngestionLogsSortByEnum(val string) (ListVectorStoreConnectorIngestionLogsSortByEnum, bool)
GetMappingListVectorStoreConnectorIngestionLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorIngestionLogsSortOrderEnum Enum with underlying type: string
type ListVectorStoreConnectorIngestionLogsSortOrderEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorIngestionLogsSortOrderEnum
const (
ListVectorStoreConnectorIngestionLogsSortOrderAsc ListVectorStoreConnectorIngestionLogsSortOrderEnum = "ASC"
ListVectorStoreConnectorIngestionLogsSortOrderDesc ListVectorStoreConnectorIngestionLogsSortOrderEnum = "DESC"
)
func GetListVectorStoreConnectorIngestionLogsSortOrderEnumValues() []ListVectorStoreConnectorIngestionLogsSortOrderEnum
GetListVectorStoreConnectorIngestionLogsSortOrderEnumValues Enumerates the set of values for ListVectorStoreConnectorIngestionLogsSortOrderEnum
func GetMappingListVectorStoreConnectorIngestionLogsSortOrderEnum(val string) (ListVectorStoreConnectorIngestionLogsSortOrderEnum, bool)
GetMappingListVectorStoreConnectorIngestionLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorsRequest wrapper for the ListVectorStoreConnectors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListVectorStoreConnectors.go.html to see an example of how to use ListVectorStoreConnectorsRequest.
type ListVectorStoreConnectorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The openai compatible id of the VectorStore.
VectorStoreId *string `mandatory:"false" contributesTo:"query" name:"vectorStoreId"`
// A filter to return only resources whose lifecycle state matches the given value.
LifecycleState VectorStoreConnectorLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListVectorStoreConnectorsSortOrderEnum `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 `name` is ascending.
SortBy ListVectorStoreConnectorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVectorStoreConnectorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVectorStoreConnectorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVectorStoreConnectorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVectorStoreConnectorsRequest) String() string
func (request ListVectorStoreConnectorsRequest) 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
ListVectorStoreConnectorsResponse wrapper for the ListVectorStoreConnectors operation
type ListVectorStoreConnectorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of VectorStoreConnectorCollection instances
VectorStoreConnectorCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListVectorStoreConnectorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVectorStoreConnectorsResponse) String() string
ListVectorStoreConnectorsSortByEnum Enum with underlying type: string
type ListVectorStoreConnectorsSortByEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorsSortByEnum
const (
ListVectorStoreConnectorsSortByName ListVectorStoreConnectorsSortByEnum = "name"
ListVectorStoreConnectorsSortByTimecreated ListVectorStoreConnectorsSortByEnum = "timeCreated"
)
func GetListVectorStoreConnectorsSortByEnumValues() []ListVectorStoreConnectorsSortByEnum
GetListVectorStoreConnectorsSortByEnumValues Enumerates the set of values for ListVectorStoreConnectorsSortByEnum
func GetMappingListVectorStoreConnectorsSortByEnum(val string) (ListVectorStoreConnectorsSortByEnum, bool)
GetMappingListVectorStoreConnectorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVectorStoreConnectorsSortOrderEnum Enum with underlying type: string
type ListVectorStoreConnectorsSortOrderEnum string
Set of constants representing the allowable values for ListVectorStoreConnectorsSortOrderEnum
const (
ListVectorStoreConnectorsSortOrderAsc ListVectorStoreConnectorsSortOrderEnum = "ASC"
ListVectorStoreConnectorsSortOrderDesc ListVectorStoreConnectorsSortOrderEnum = "DESC"
)
func GetListVectorStoreConnectorsSortOrderEnumValues() []ListVectorStoreConnectorsSortOrderEnum
GetListVectorStoreConnectorsSortOrderEnumValues Enumerates the set of values for ListVectorStoreConnectorsSortOrderEnum
func GetMappingListVectorStoreConnectorsSortOrderEnum(val string) (ListVectorStoreConnectorsSortOrderEnum, bool)
GetMappingListVectorStoreConnectorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.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.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.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 'ASC' or 'DESC'.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.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.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.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 'ASC' or 'DESC'.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.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.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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
LlmSelection LLM selection configuration.
type LlmSelection interface {
}
LlmSelectionLlmSelectionTypeEnum Enum with underlying type: string
type LlmSelectionLlmSelectionTypeEnum string
Set of constants representing the allowable values for LlmSelectionLlmSelectionTypeEnum
const (
LlmSelectionLlmSelectionTypeGenAiModel LlmSelectionLlmSelectionTypeEnum = "GEN_AI_MODEL"
)
func GetLlmSelectionLlmSelectionTypeEnumValues() []LlmSelectionLlmSelectionTypeEnum
GetLlmSelectionLlmSelectionTypeEnumValues Enumerates the set of values for LlmSelectionLlmSelectionTypeEnum
func GetMappingLlmSelectionLlmSelectionTypeEnum(val string) (LlmSelectionLlmSelectionTypeEnum, bool)
GetMappingLlmSelectionLlmSelectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LongTermMemoryConfig Configuration settings for long-term memory behavior.
type LongTermMemoryConfig struct {
StandardLongTermMemoryStrategy *StandardLongTermMemoryStrategy `mandatory:"false" json:"standardLongTermMemoryStrategy"`
}
func (m LongTermMemoryConfig) String() string
func (m LongTermMemoryConfig) 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
LoraTrainingConfig The Lora training method hyperparameters.
type LoraTrainingConfig struct {
// The maximum number of training epochs to run for.
TotalTrainingEpochs *int `mandatory:"false" json:"totalTrainingEpochs"`
// The initial learning rate to be used during training
LearningRate *float64 `mandatory:"false" json:"learningRate"`
// The batch size used during training.
TrainingBatchSize *int `mandatory:"false" json:"trainingBatchSize"`
// Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
EarlyStoppingPatience *int `mandatory:"false" json:"earlyStoppingPatience"`
// How much the loss must improve to prevent early stopping.
EarlyStoppingThreshold *float64 `mandatory:"false" json:"earlyStoppingThreshold"`
// Determines how frequently to log model metrics.
// Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
LogModelMetricsIntervalInSteps *int `mandatory:"false" json:"logModelMetricsIntervalInSteps"`
// This parameter represents the LoRA rank of the update matrices.
LoraR *int `mandatory:"false" json:"loraR"`
// This parameter represents the scaling factor for the weight matrices in LoRA.
LoraAlpha *int `mandatory:"false" json:"loraAlpha"`
// This parameter indicates the dropout probability for LoRA layers.
LoraDropout *float64 `mandatory:"false" json:"loraDropout"`
}
func (m LoraTrainingConfig) GetEarlyStoppingPatience() *int
GetEarlyStoppingPatience returns EarlyStoppingPatience
func (m LoraTrainingConfig) GetEarlyStoppingThreshold() *float64
GetEarlyStoppingThreshold returns EarlyStoppingThreshold
func (m LoraTrainingConfig) GetLearningRate() *float64
GetLearningRate returns LearningRate
func (m LoraTrainingConfig) GetLogModelMetricsIntervalInSteps() *int
GetLogModelMetricsIntervalInSteps returns LogModelMetricsIntervalInSteps
func (m LoraTrainingConfig) GetTotalTrainingEpochs() *int
GetTotalTrainingEpochs returns TotalTrainingEpochs
func (m LoraTrainingConfig) GetTrainingBatchSize() *int
GetTrainingBatchSize returns TrainingBatchSize
func (m LoraTrainingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LoraTrainingConfig) String() string
func (m LoraTrainingConfig) 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
Model You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a custom model. See Training Data Requirements (https://docs.oracle.com/iaas/Content/generative-ai/training-data-requirements.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type Model struct {
// An ID that uniquely identifies a pretrained or fine-tuned model.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID for fine-tuned models. For pretrained models, this value is null.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Describes what this model can be used for.
Capabilities []ModelCapabilityEnum `mandatory:"true" json:"capabilities"`
// The lifecycle state of the model.
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time that the model was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
Type ModelTypeEnum `mandatory:"true" json:"type"`
// An optional description of the model.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state of the model in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The provider of the base model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the model.
Version *string `mandatory:"false" json:"version"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time that the model was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null.
BaseModelId *string `mandatory:"false" json:"baseModelId"`
FineTuneDetails *FineTuneDetails `mandatory:"false" json:"fineTuneDetails"`
ModelMetrics ModelMetrics `mandatory:"false" json:"modelMetrics"`
// Whether a model is supported long-term. Only applicable to base models.
IsLongTermSupported *bool `mandatory:"false" json:"isLongTermSupported"`
// Corresponds to the time when the custom model and its associated foundation model will be deprecated.
TimeDeprecated *common.SDKTime `mandatory:"false" json:"timeDeprecated"`
// The timestamp indicating when the base model will no longer be available for on-demand usage.
TimeOnDemandRetired *common.SDKTime `mandatory:"false" json:"timeOnDemandRetired"`
// The timestamp indicating when the custom model and its associated foundation model will be fully retired.
TimeDedicatedRetired *common.SDKTime `mandatory:"false" json:"timeDedicatedRetired"`
PreviousState *Model `mandatory:"false" json:"previousState"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Model) String() string
func (m *Model) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Model) 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
ModelCapabilityEnum Enum with underlying type: string
type ModelCapabilityEnum string
Set of constants representing the allowable values for ModelCapabilityEnum
const (
ModelCapabilityTextGeneration ModelCapabilityEnum = "TEXT_GENERATION"
ModelCapabilityTextSummarization ModelCapabilityEnum = "TEXT_SUMMARIZATION"
ModelCapabilityTextEmbeddings ModelCapabilityEnum = "TEXT_EMBEDDINGS"
ModelCapabilityFineTune ModelCapabilityEnum = "FINE_TUNE"
ModelCapabilityChat ModelCapabilityEnum = "CHAT"
ModelCapabilityTextRerank ModelCapabilityEnum = "TEXT_RERANK"
ModelCapabilityTextToImage ModelCapabilityEnum = "TEXT_TO_IMAGE"
)
func GetMappingModelCapabilityEnum(val string) (ModelCapabilityEnum, bool)
GetMappingModelCapabilityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelCapabilityEnumValues() []ModelCapabilityEnum
GetModelCapabilityEnumValues Enumerates the set of values for ModelCapabilityEnum
ModelCollection Results of a model search. Contains ModelSummary items and other information such as metadata.
type ModelCollection struct {
// The results of a model search.
Items []ModelSummary `mandatory:"true" json:"items"`
}
func (m ModelCollection) String() string
func (m ModelCollection) 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
ModelConfig Base model configuration shared across GenAI Project memory.
type ModelConfig interface {
GetLlmSelection() LlmSelection
}
ModelConfigModelConfigTypeEnum Enum with underlying type: string
type ModelConfigModelConfigTypeEnum string
Set of constants representing the allowable values for ModelConfigModelConfigTypeEnum
const (
ModelConfigModelConfigTypeExtraction ModelConfigModelConfigTypeEnum = "EXTRACTION"
ModelConfigModelConfigTypeEmbedding ModelConfigModelConfigTypeEnum = "EMBEDDING"
ModelConfigModelConfigTypeCondenser ModelConfigModelConfigTypeEnum = "CONDENSER"
)
func GetMappingModelConfigModelConfigTypeEnum(val string) (ModelConfigModelConfigTypeEnum, bool)
GetMappingModelConfigModelConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelConfigModelConfigTypeEnumValues() []ModelConfigModelConfigTypeEnum
GetModelConfigModelConfigTypeEnumValues Enumerates the set of values for ModelConfigModelConfigTypeEnum
ModelDataSource Defines the source location and method used to import the model. Supports importing from Hugging Face, an Object Storage location, or by referencing an already imported model.
type ModelDataSource interface {
}
ModelDataSourceSourceTypeEnum Enum with underlying type: string
type ModelDataSourceSourceTypeEnum string
Set of constants representing the allowable values for ModelDataSourceSourceTypeEnum
const (
ModelDataSourceSourceTypeHuggingFaceModel ModelDataSourceSourceTypeEnum = "HUGGING_FACE_MODEL"
ModelDataSourceSourceTypeObjectStorageObject ModelDataSourceSourceTypeEnum = "OBJECT_STORAGE_OBJECT"
)
func GetMappingModelDataSourceSourceTypeEnum(val string) (ModelDataSourceSourceTypeEnum, bool)
GetMappingModelDataSourceSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelDataSourceSourceTypeEnumValues() []ModelDataSourceSourceTypeEnum
GetModelDataSourceSourceTypeEnumValues Enumerates the set of values for ModelDataSourceSourceTypeEnum
ModelLifecycleStateEnum Enum with underlying type: string
type ModelLifecycleStateEnum string
Set of constants representing the allowable values for ModelLifecycleStateEnum
const (
ModelLifecycleStateActive ModelLifecycleStateEnum = "ACTIVE"
ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
ModelLifecycleStateDeleted ModelLifecycleStateEnum = "DELETED"
ModelLifecycleStateFailed ModelLifecycleStateEnum = "FAILED"
)
func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)
GetMappingModelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum
GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum
ModelMetrics Model metrics during the creation of a new model.
type ModelMetrics interface {
}
ModelMetricsModelMetricsTypeEnum Enum with underlying type: string
type ModelMetricsModelMetricsTypeEnum string
Set of constants representing the allowable values for ModelMetricsModelMetricsTypeEnum
const (
ModelMetricsModelMetricsTypeTextGenerationModelMetrics ModelMetricsModelMetricsTypeEnum = "TEXT_GENERATION_MODEL_METRICS"
ModelMetricsModelMetricsTypeChatModelMetrics ModelMetricsModelMetricsTypeEnum = "CHAT_MODEL_METRICS"
)
func GetMappingModelMetricsModelMetricsTypeEnum(val string) (ModelMetricsModelMetricsTypeEnum, bool)
GetMappingModelMetricsModelMetricsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelMetricsModelMetricsTypeEnumValues() []ModelMetricsModelMetricsTypeEnum
GetModelMetricsModelMetricsTypeEnumValues Enumerates the set of values for ModelMetricsModelMetricsTypeEnum
ModelSummary Summary of the model.
type ModelSummary struct {
// An ID that uniquely identifies a pretrained or a fine-tuned model.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID for fine-tuned models. For pretrained models, this value is null.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Describes what this model can be used for.
Capabilities []ModelCapabilityEnum `mandatory:"true" json:"capabilities"`
// The lifecycle state of the model.
// Allowed values are:
// - ACTIVE
// - CREATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time that the model was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
// Allowed values are:
// - BASE
// - CUSTOM
Type ModelTypeEnum `mandatory:"true" json:"type"`
// A message describing the current state of the model with detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The provider of the model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the model.
Version *string `mandatory:"false" json:"version"`
// The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null.
BaseModelId *string `mandatory:"false" json:"baseModelId"`
FineTuneDetails *FineTuneDetails `mandatory:"false" json:"fineTuneDetails"`
ModelMetrics ModelMetrics `mandatory:"false" json:"modelMetrics"`
// Whether a model is supported long-term. Applies only to base models.
IsLongTermSupported *bool `mandatory:"false" json:"isLongTermSupported"`
// Corresponds to the time when the custom model and its associated foundation model will be deprecated.
TimeDeprecated *common.SDKTime `mandatory:"false" json:"timeDeprecated"`
// The timestamp indicating when the base model will no longer be available for on-demand usage.
TimeOnDemandRetired *common.SDKTime `mandatory:"false" json:"timeOnDemandRetired"`
// The timestamp indicating when the custom model and its associated foundation model will be fully retired.
TimeDedicatedRetired *common.SDKTime `mandatory:"false" json:"timeDedicatedRetired"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ModelSummary) String() string
func (m *ModelSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ModelSummary) 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
ModelTypeEnum Enum with underlying type: string
type ModelTypeEnum string
Set of constants representing the allowable values for ModelTypeEnum
const (
ModelTypeBase ModelTypeEnum = "BASE"
ModelTypeCustom ModelTypeEnum = "CUSTOM"
)
func GetMappingModelTypeEnum(val string) (ModelTypeEnum, bool)
GetMappingModelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelTypeEnumValues() []ModelTypeEnum
GetModelTypeEnumValues Enumerates the set of values for ModelTypeEnum
NetworkingConfig Networking configuration.
type NetworkingConfig struct {
InboundNetworkingConfig *InboundNetworkingConfig `mandatory:"true" json:"inboundNetworkingConfig"`
OutboundNetworkingConfig *OutboundNetworkingConfig `mandatory:"true" json:"outboundNetworkingConfig"`
}
func (m NetworkingConfig) String() string
func (m NetworkingConfig) 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
ObjectStorageConfig OCI Object storage configuration details.
type ObjectStorageConfig struct {
// The Object Storage namespace.
Namespace *string `mandatory:"true" json:"namespace"`
// The Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// Optional object prefix
PrefixList []string `mandatory:"false" json:"prefixList"`
}
func (m ObjectStorageConfig) String() string
func (m ObjectStorageConfig) 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
ObjectStorageDataset The dataset is stored in an OCI Object Storage bucket.
type ObjectStorageDataset struct {
// The Object Storage namespace.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// The Object Storage object name.
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m ObjectStorageDataset) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageDataset) String() string
func (m ObjectStorageDataset) 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
ObjectStorageObject Details about the object storage location.
type ObjectStorageObject struct {
// The namespace of the Object Storage where the files are stored.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The name of the Object Storage bucket.
BucketName *string `mandatory:"true" json:"bucketName"`
// The prefix path (or folder) within the bucket where files are located.
PrefixName *string `mandatory:"true" json:"prefixName"`
// The full canonical Oracle Cloud region identifier (e.g., "us-ashburn-1") where the object storage bucket
// containing the files resides.
Region *string `mandatory:"false" json:"region"`
}
func (m ObjectStorageObject) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageObject) String() string
func (m ObjectStorageObject) 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
OciObjectStorageConfiguration The OCI Object Storage namespace and bucket details of the datasource
type OciObjectStorageConfiguration struct {
// List of Object Storage Configurations for datasource.
StorageConfigList []ObjectStorageConfig `mandatory:"true" json:"storageConfigList"`
}
func (m OciObjectStorageConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciObjectStorageConfiguration) String() string
func (m OciObjectStorageConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateModel OperationTypeEnum = "CREATE_MODEL"
OperationTypeDeleteModel OperationTypeEnum = "DELETE_MODEL"
OperationTypeMoveModel OperationTypeEnum = "MOVE_MODEL"
OperationTypeCreateDedicatedAiCluster OperationTypeEnum = "CREATE_DEDICATED_AI_CLUSTER"
OperationTypeDeleteDedicatedAiCluster OperationTypeEnum = "DELETE_DEDICATED_AI_CLUSTER"
OperationTypeUpdateDedicatedAiCluster OperationTypeEnum = "UPDATE_DEDICATED_AI_CLUSTER"
OperationTypeMoveDedicatedAiCluster OperationTypeEnum = "MOVE_DEDICATED_AI_CLUSTER"
OperationTypeCreateEndpoint OperationTypeEnum = "CREATE_ENDPOINT"
OperationTypeDeleteEndpoint OperationTypeEnum = "DELETE_ENDPOINT"
OperationTypeUpdateEndpoint OperationTypeEnum = "UPDATE_ENDPOINT"
OperationTypeMoveEndpoint OperationTypeEnum = "MOVE_ENDPOINT"
OperationTypeCreateImportedModel OperationTypeEnum = "CREATE_IMPORTED_MODEL"
OperationTypeUpdateImportedModel OperationTypeEnum = "UPDATE_IMPORTED_MODEL"
OperationTypeDeleteImportedModel OperationTypeEnum = "DELETE_IMPORTED_MODEL"
OperationTypeCreatePrivateEndpoint OperationTypeEnum = "CREATE_PRIVATE_ENDPOINT"
OperationTypeDeletePrivateEndpoint OperationTypeEnum = "DELETE_PRIVATE_ENDPOINT"
OperationTypeUpdatePrivateEndpoint OperationTypeEnum = "UPDATE_PRIVATE_ENDPOINT"
OperationTypeMovePrivateEndpoint OperationTypeEnum = "MOVE_PRIVATE_ENDPOINT"
OperationTypeCreateVectorStoreConnector OperationTypeEnum = "CREATE_VECTOR_STORE_CONNECTOR"
OperationTypeUpdateVectorStoreConnector OperationTypeEnum = "UPDATE_VECTOR_STORE_CONNECTOR"
OperationTypeDeleteVectorStoreConnector OperationTypeEnum = "DELETE_VECTOR_STORE_CONNECTOR"
OperationTypeScheduleFileSync OperationTypeEnum = "SCHEDULE_FILE_SYNC"
OperationTypeTriggerFileSync OperationTypeEnum = "TRIGGER_FILE_SYNC"
OperationTypeCreateSemanticStore OperationTypeEnum = "CREATE_SEMANTIC_STORE"
OperationTypeDeleteSemanticStore OperationTypeEnum = "DELETE_SEMANTIC_STORE"
OperationTypeMoveSemanticStore OperationTypeEnum = "MOVE_SEMANTIC_STORE"
OperationTypeCreateApplicationDeployment OperationTypeEnum = "CREATE_APPLICATION_DEPLOYMENT"
OperationTypeUpdateApplicationDeployment OperationTypeEnum = "UPDATE_APPLICATION_DEPLOYMENT"
OperationTypeDeleteApplicationDeployment OperationTypeEnum = "DELETE_APPLICATION_DEPLOYMENT"
OperationTypeMoveApplicationDeployment OperationTypeEnum = "MOVE_APPLICATION_DEPLOYMENT"
OperationTypeCreateHostedDeployment OperationTypeEnum = "CREATE_HOSTED_DEPLOYMENT"
OperationTypeUpdateHostedDeployment OperationTypeEnum = "UPDATE_HOSTED_DEPLOYMENT"
OperationTypeMoveHostedDeployment OperationTypeEnum = "MOVE_HOSTED_DEPLOYMENT"
OperationTypeDeleteHostedDeployment OperationTypeEnum = "DELETE_HOSTED_DEPLOYMENT"
OperationTypeStartLogging OperationTypeEnum = "START_LOGGING"
OperationTypeStopLogging OperationTypeEnum = "STOP_LOGGING"
OperationTypeCreateApplicationStorage OperationTypeEnum = "CREATE_APPLICATION_STORAGE"
OperationTypeUpdateApplicationStorage OperationTypeEnum = "UPDATE_APPLICATION_STORAGE"
OperationTypeMoveApplicationStorage OperationTypeEnum = "MOVE_APPLICATION_STORAGE"
OperationTypeDeleteApplicationStorage OperationTypeEnum = "DELETE_APPLICATION_STORAGE"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
OutboundNetworkingConfig Outbound Networking configuration.
type OutboundNetworkingConfig struct {
// outbounding to managed internet or customer network.
NetworkMode OutboundNetworkingConfigNetworkModeEnum `mandatory:"true" json:"networkMode"`
// ocid of customer subnet when networkMode=Custom
CustomSubnetId *string `mandatory:"false" json:"customSubnetId"`
// A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
}
func (m OutboundNetworkingConfig) String() string
func (m OutboundNetworkingConfig) 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
OutboundNetworkingConfigNetworkModeEnum Enum with underlying type: string
type OutboundNetworkingConfigNetworkModeEnum string
Set of constants representing the allowable values for OutboundNetworkingConfigNetworkModeEnum
const (
OutboundNetworkingConfigNetworkModeManaged OutboundNetworkingConfigNetworkModeEnum = "MANAGED"
OutboundNetworkingConfigNetworkModeCustom OutboundNetworkingConfigNetworkModeEnum = "CUSTOM"
)
func GetMappingOutboundNetworkingConfigNetworkModeEnum(val string) (OutboundNetworkingConfigNetworkModeEnum, bool)
GetMappingOutboundNetworkingConfigNetworkModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOutboundNetworkingConfigNetworkModeEnumValues() []OutboundNetworkingConfigNetworkModeEnum
GetOutboundNetworkingConfigNetworkModeEnumValues Enumerates the set of values for OutboundNetworkingConfigNetworkModeEnum
PiiDetectionConfig The configuration details for personally identifiable information (PII) detection, in prompts and responses.
type PiiDetectionConfig struct {
// Whether to enable the PII detection feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The mode of operation for PII detection.
Mode ContentModerationConfigModeEnum `mandatory:"false" json:"mode,omitempty"`
// The OCID of the model used for the feature.
ModelId *string `mandatory:"false" json:"modelId"`
}
func (m PiiDetectionConfig) String() string
func (m PiiDetectionConfig) 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
PromptInjectionConfig The configuration details for prompt injection (PI) detection. This is for input only.
type PromptInjectionConfig struct {
// Whether to enable the prompt injection feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The mode of operation for prompt injection detection.
Mode ContentModerationConfigModeEnum `mandatory:"false" json:"mode,omitempty"`
// The OCID of the model used for the feature.
ModelId *string `mandatory:"false" json:"modelId"`
}
func (m PromptInjectionConfig) String() string
func (m PromptInjectionConfig) 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
RefreshScheduleDetails Specifies a refresh schedule. Null represents no automated synchronization schedule.
type RefreshScheduleDetails interface {
}
RefreshScheduleDetailsTypeEnum Enum with underlying type: string
type RefreshScheduleDetailsTypeEnum string
Set of constants representing the allowable values for RefreshScheduleDetailsTypeEnum
const (
RefreshScheduleDetailsTypeInterval RefreshScheduleDetailsTypeEnum = "INTERVAL"
RefreshScheduleDetailsTypeOnCreate RefreshScheduleDetailsTypeEnum = "ON_CREATE"
RefreshScheduleDetailsTypeNone RefreshScheduleDetailsTypeEnum = "NONE"
)
func GetMappingRefreshScheduleDetailsTypeEnum(val string) (RefreshScheduleDetailsTypeEnum, bool)
GetMappingRefreshScheduleDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRefreshScheduleDetailsTypeEnumValues() []RefreshScheduleDetailsTypeEnum
GetRefreshScheduleDetailsTypeEnumValues Enumerates the set of values for RefreshScheduleDetailsTypeEnum
RefreshScheduleIntervalDetails Defines the refresh schedule by specifying the interval between each refresh.
type RefreshScheduleIntervalDetails struct {
// Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS,
// where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed.
// For example, "P1DT6H" represents a duration of 1 day and 6 hours.
Value *string `mandatory:"true" json:"value"`
}
func (m RefreshScheduleIntervalDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RefreshScheduleIntervalDetails) String() string
func (m RefreshScheduleIntervalDetails) 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
RefreshScheduleNoneDetails Allows user to opt out of automated synchronization schedule.
type RefreshScheduleNoneDetails struct {
}
func (m RefreshScheduleNoneDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RefreshScheduleNoneDetails) String() string
func (m RefreshScheduleNoneDetails) 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
RefreshScheduleOnCreateDetails Only trigger the enrichment at the creation time.
type RefreshScheduleOnCreateDetails struct {
}
func (m RefreshScheduleOnCreateDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RefreshScheduleOnCreateDetails) String() string
func (m RefreshScheduleOnCreateDetails) 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
RenewApiKeyDetails The data to renew an API key item.
type RenewApiKeyDetails struct {
Details *KeyDetails `mandatory:"true" json:"details"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m RenewApiKeyDetails) String() string
func (m RenewApiKeyDetails) 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
RenewApiKeyRequest wrapper for the RenewApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/RenewApiKey.go.html to see an example of how to use RenewApiKeyRequest.
type RenewApiKeyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`
// The information to be renewed.
RenewApiKeyDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RenewApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RenewApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RenewApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RenewApiKeyRequest) String() string
func (request RenewApiKeyRequest) 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
RenewApiKeyResponse wrapper for the RenewApiKey operation
type RenewApiKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiKey instance
ApiKey `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response RenewApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RenewApiKeyResponse) String() string
ScalingConfig The auto scaling configuration for the Hosted Application. Defines the minimum and maximum number of replicas. When unspecified, the service applies service-defined default scaling values.
type ScalingConfig struct {
// scaling type for application.
ScalingType ScalingConfigScalingTypeEnum `mandatory:"true" json:"scalingType"`
// Minimum number of replicas to keep running.
MinReplica *int `mandatory:"false" json:"minReplica"`
// Maximum number of replicas allowed.
MaxReplica *int `mandatory:"false" json:"maxReplica"`
// Scale up if average CPU utilization exceeds this threshold.
TargetCpuThreshold *int `mandatory:"false" json:"targetCpuThreshold"`
// Scale up if average memory utilization exceeds this threshold.
TargetMemoryThreshold *int `mandatory:"false" json:"targetMemoryThreshold"`
// number of simultaneous requests that can be processed by each replica.
TargetConcurrencyThreshold *int `mandatory:"false" json:"targetConcurrencyThreshold"`
// requests-per-second per replica of an application.
TargetRpsThreshold *int `mandatory:"false" json:"targetRpsThreshold"`
}
func (m ScalingConfig) String() string
func (m ScalingConfig) 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
ScalingConfigScalingTypeEnum Enum with underlying type: string
type ScalingConfigScalingTypeEnum string
Set of constants representing the allowable values for ScalingConfigScalingTypeEnum
const (
ScalingConfigScalingTypeCpu ScalingConfigScalingTypeEnum = "CPU"
ScalingConfigScalingTypeMemory ScalingConfigScalingTypeEnum = "MEMORY"
ScalingConfigScalingTypeConcurrency ScalingConfigScalingTypeEnum = "CONCURRENCY"
ScalingConfigScalingTypeRequestsPerSecond ScalingConfigScalingTypeEnum = "REQUESTS_PER_SECOND"
)
func GetMappingScalingConfigScalingTypeEnum(val string) (ScalingConfigScalingTypeEnum, bool)
GetMappingScalingConfigScalingTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScalingConfigScalingTypeEnumValues() []ScalingConfigScalingTypeEnum
GetScalingConfigScalingTypeEnumValues Enumerates the set of values for ScalingConfigScalingTypeEnum
ScheduleConfig The Schedule configuration of a VectorStoreConnector to trigger a File Sync Operation.
type ScheduleConfig interface {
// The state of the schedule. The state can be either ENABLED or DISABLED.
GetState() ScheduleConfigStateEnum
// The schedule starting date time, if null, System set the time when schedule is created.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
GetTimeStart() *common.SDKTime
// The schedule end date time, if null, the schedule will never expire.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
GetTimeEnd() *common.SDKTime
}
ScheduleConfigConfigTypeEnum Enum with underlying type: string
type ScheduleConfigConfigTypeEnum string
Set of constants representing the allowable values for ScheduleConfigConfigTypeEnum
const (
ScheduleConfigConfigTypeInterval ScheduleConfigConfigTypeEnum = "INTERVAL"
ScheduleConfigConfigTypeCron ScheduleConfigConfigTypeEnum = "CRON"
)
func GetMappingScheduleConfigConfigTypeEnum(val string) (ScheduleConfigConfigTypeEnum, bool)
GetMappingScheduleConfigConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleConfigConfigTypeEnumValues() []ScheduleConfigConfigTypeEnum
GetScheduleConfigConfigTypeEnumValues Enumerates the set of values for ScheduleConfigConfigTypeEnum
ScheduleConfigStateEnum Enum with underlying type: string
type ScheduleConfigStateEnum string
Set of constants representing the allowable values for ScheduleConfigStateEnum
const (
ScheduleConfigStateEnabled ScheduleConfigStateEnum = "ENABLED"
ScheduleConfigStateDisabled ScheduleConfigStateEnum = "DISABLED"
)
func GetMappingScheduleConfigStateEnum(val string) (ScheduleConfigStateEnum, bool)
GetMappingScheduleConfigStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleConfigStateEnumValues() []ScheduleConfigStateEnum
GetScheduleConfigStateEnumValues Enumerates the set of values for ScheduleConfigStateEnum
ScheduleCronConfig The scheduled UNIX cron definition.
type ScheduleCronConfig struct {
// Schedule cron expression
CronExpression *string `mandatory:"true" json:"cronExpression"`
// The schedule starting date time, if null, System set the time when schedule is created.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// The schedule end date time, if null, the schedule will never expire.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// The state of the schedule. The state can be either ENABLED or DISABLED.
State ScheduleConfigStateEnum `mandatory:"false" json:"state,omitempty"`
}
func (m ScheduleCronConfig) GetState() ScheduleConfigStateEnum
GetState returns State
func (m ScheduleCronConfig) GetTimeEnd() *common.SDKTime
GetTimeEnd returns TimeEnd
func (m ScheduleCronConfig) GetTimeStart() *common.SDKTime
GetTimeStart returns TimeStart
func (m ScheduleCronConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ScheduleCronConfig) String() string
func (m ScheduleCronConfig) 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
ScheduleIntervalConfig The interval schedule config.
type ScheduleIntervalConfig struct {
// The interval of frequency.
Interval *int `mandatory:"true" json:"interval"`
// The schedule starting date time, if null, System set the time when schedule is created.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// The schedule end date time, if null, the schedule will never expire.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// The type of frequency
Frequency ScheduleIntervalConfigFrequencyEnum `mandatory:"true" json:"frequency"`
// The state of the schedule. The state can be either ENABLED or DISABLED.
State ScheduleConfigStateEnum `mandatory:"false" json:"state,omitempty"`
}
func (m ScheduleIntervalConfig) GetState() ScheduleConfigStateEnum
GetState returns State
func (m ScheduleIntervalConfig) GetTimeEnd() *common.SDKTime
GetTimeEnd returns TimeEnd
func (m ScheduleIntervalConfig) GetTimeStart() *common.SDKTime
GetTimeStart returns TimeStart
func (m ScheduleIntervalConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ScheduleIntervalConfig) String() string
func (m ScheduleIntervalConfig) 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
ScheduleIntervalConfigFrequencyEnum Enum with underlying type: string
type ScheduleIntervalConfigFrequencyEnum string
Set of constants representing the allowable values for ScheduleIntervalConfigFrequencyEnum
const (
ScheduleIntervalConfigFrequencyHourly ScheduleIntervalConfigFrequencyEnum = "HOURLY"
ScheduleIntervalConfigFrequencyDaily ScheduleIntervalConfigFrequencyEnum = "DAILY"
)
func GetMappingScheduleIntervalConfigFrequencyEnum(val string) (ScheduleIntervalConfigFrequencyEnum, bool)
GetMappingScheduleIntervalConfigFrequencyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleIntervalConfigFrequencyEnumValues() []ScheduleIntervalConfigFrequencyEnum
GetScheduleIntervalConfigFrequencyEnumValues Enumerates the set of values for ScheduleIntervalConfigFrequencyEnum
SchemaItem Represents a database schema identified by name. This is the simplest schema definition and includes only schema name now. Additional configuration options may be supported in extended forms later.
type SchemaItem struct {
Name *string `mandatory:"true" json:"name"`
}
func (m SchemaItem) String() string
func (m SchemaItem) 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
SchemasDatabaseToolsConnectionDetails Array of database schemas or database objects included in the enrichment pipeline for data sources connected via an OCI Database Tools connection.
type SchemasDatabaseToolsConnectionDetails struct {
// Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: {
// "schemas": [
// { "name": "HR" }
// ]
// } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
Schemas []SchemaItem `mandatory:"true" json:"schemas"`
}
func (m SchemasDatabaseToolsConnectionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SchemasDatabaseToolsConnectionDetails) String() string
func (m SchemasDatabaseToolsConnectionDetails) 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
SchemasDetails Array of database schemas or other database objects to include in enrichment pipeline.
type SchemasDetails interface {
}
SchemasDetailsConnectionTypeEnum Enum with underlying type: string
type SchemasDetailsConnectionTypeEnum string
Set of constants representing the allowable values for SchemasDetailsConnectionTypeEnum
const (
SchemasDetailsConnectionTypeDatabaseToolsConnection SchemasDetailsConnectionTypeEnum = "DATABASE_TOOLS_CONNECTION"
)
func GetMappingSchemasDetailsConnectionTypeEnum(val string) (SchemasDetailsConnectionTypeEnum, bool)
GetMappingSchemasDetailsConnectionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSchemasDetailsConnectionTypeEnumValues() []SchemasDetailsConnectionTypeEnum
GetSchemasDetailsConnectionTypeEnumValues Enumerates the set of values for SchemasDetailsConnectionTypeEnum
SemanticStore A Semantic Store is a container resource of semantic records, with controllable enrichment refresh and synchronization policy. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resources (https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type SemanticStore struct {
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that uniquely identifies a SemanticStore.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name.
DisplayName *string `mandatory:"true" json:"displayName"`
// Owning compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for a SemanticStore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The lifecycle state of a SemanticStore.
LifecycleState SemanticStoreLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
DataSource DataSourceDetails `mandatory:"true" json:"dataSource"`
Schemas SchemasDetails `mandatory:"true" json:"schemas"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" 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:"true" json:"systemTags"`
// An optional description of the SemanticStore.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
RefreshSchedule RefreshScheduleDetails `mandatory:"false" json:"refreshSchedule"`
}
func (m SemanticStore) String() string
func (m *SemanticStore) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SemanticStore) 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
SemanticStoreCollection Results of a SemanticStore list. Contains SemanticStoreSummary items and other information such as metadata.
type SemanticStoreCollection struct {
// List of SemanticStores.
Items []SemanticStoreSummary `mandatory:"true" json:"items"`
}
func (m SemanticStoreCollection) String() string
func (m SemanticStoreCollection) 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
SemanticStoreLifecycleStateEnum Enum with underlying type: string
type SemanticStoreLifecycleStateEnum string
Set of constants representing the allowable values for SemanticStoreLifecycleStateEnum
const (
SemanticStoreLifecycleStateActive SemanticStoreLifecycleStateEnum = "ACTIVE"
SemanticStoreLifecycleStateCreating SemanticStoreLifecycleStateEnum = "CREATING"
SemanticStoreLifecycleStateUpdating SemanticStoreLifecycleStateEnum = "UPDATING"
SemanticStoreLifecycleStateDeleting SemanticStoreLifecycleStateEnum = "DELETING"
SemanticStoreLifecycleStateDeleted SemanticStoreLifecycleStateEnum = "DELETED"
SemanticStoreLifecycleStateFailed SemanticStoreLifecycleStateEnum = "FAILED"
)
func GetMappingSemanticStoreLifecycleStateEnum(val string) (SemanticStoreLifecycleStateEnum, bool)
GetMappingSemanticStoreLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSemanticStoreLifecycleStateEnumValues() []SemanticStoreLifecycleStateEnum
GetSemanticStoreLifecycleStateEnumValues Enumerates the set of values for SemanticStoreLifecycleStateEnum
SemanticStoreSummary Summary information for a SemanticStore.
type SemanticStoreSummary struct {
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that uniquely identifies a SemanticStore.
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"`
// Owning compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for a SemanticStore.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
DataSource DataSourceDetails `mandatory:"true" json:"dataSource"`
Schemas SchemasDetails `mandatory:"true" json:"schemas"`
// The date and time that the semanticStore was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the semanticStore was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the SemanticStore.
// Allowed values are:
// - ACTIVE
// - CREATING
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState SemanticStoreLifecycleStateEnum `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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" 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:"true" json:"systemTags"`
// An optional description of the SemanticStore.
Description *string `mandatory:"false" json:"description"`
RefreshSchedule RefreshScheduleDetails `mandatory:"false" json:"refreshSchedule"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m SemanticStoreSummary) String() string
func (m *SemanticStoreSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SemanticStoreSummary) 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
SetApiKeyStateDetails The data to set the state of an API key item.
type SetApiKeyStateDetails struct {
// The key to set state.
KeyName *string `mandatory:"true" json:"keyName"`
// The target state of the API key item.
State ApiKeyItemStateEnum `mandatory:"true" json:"state"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m SetApiKeyStateDetails) String() string
func (m SetApiKeyStateDetails) 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
SetApiKeyStateRequest wrapper for the SetApiKeyState operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/SetApiKeyState.go.html to see an example of how to use SetApiKeyStateRequest.
type SetApiKeyStateRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`
// The information for setting key state.
SetApiKeyStateDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SetApiKeyStateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SetApiKeyStateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SetApiKeyStateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SetApiKeyStateRequest) String() string
func (request SetApiKeyStateRequest) 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
SetApiKeyStateResponse wrapper for the SetApiKeyState operation
type SetApiKeyStateResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiKey instance
ApiKey `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response SetApiKeyStateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SetApiKeyStateResponse) String() string
ShortTermMemoryOptimizationConfig Configuration settings for short-term memory optimization.
type ShortTermMemoryOptimizationConfig struct {
// Indicates whether short-term memory optimization is enabled.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
CondenserConfig *CondenserConfig `mandatory:"false" json:"condenserConfig"`
}
func (m ShortTermMemoryOptimizationConfig) String() string
func (m ShortTermMemoryOptimizationConfig) 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
SingleDockerArtifact Container/artifact configuration for the deployment.
type SingleDockerArtifact struct {
// if put artifact to a table, the id is needed
Id *string `mandatory:"false" json:"id"`
// The date and time the artifact was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
HostedDeploymentId *string `mandatory:"false" json:"hostedDeploymentId"`
// image url.
ContainerUri *string `mandatory:"false" json:"containerUri"`
// image tag.
Tag *string `mandatory:"false" json:"tag"`
// The current status of the artifact.
Status ArtifactStatusEnum `mandatory:"false" json:"status,omitempty"`
}
func (m SingleDockerArtifact) GetHostedDeploymentId() *string
GetHostedDeploymentId returns HostedDeploymentId
func (m SingleDockerArtifact) GetId() *string
GetId returns Id
func (m SingleDockerArtifact) GetStatus() ArtifactStatusEnum
GetStatus returns Status
func (m SingleDockerArtifact) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SingleDockerArtifact) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SingleDockerArtifact) String() string
func (m SingleDockerArtifact) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StandardLongTermMemoryStrategy Standard strategy settings for long-term memory.
type StandardLongTermMemoryStrategy struct {
// Indicates whether long-term memory is enabled.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
ExtractionConfig *ExtractionConfig `mandatory:"false" json:"extractionConfig"`
EmbeddingConfig *EmbeddingConfig `mandatory:"false" json:"embeddingConfig"`
}
func (m StandardLongTermMemoryStrategy) String() string
func (m StandardLongTermMemoryStrategy) 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
StorageConfig The type of service-managed storage.
type StorageConfig struct {
// The key of environment variable to store the database connection.
EnvironmentVariableKey *string `mandatory:"true" json:"environmentVariableKey"`
// The [OCID] of ApplicationStorage.
StorageId *string `mandatory:"true" json:"storageId"`
}
func (m StorageConfig) String() string
func (m StorageConfig) 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
TFewTrainingConfig The TFEW training method hyperparameters.
type TFewTrainingConfig struct {
// The maximum number of training epochs to run for.
TotalTrainingEpochs *int `mandatory:"false" json:"totalTrainingEpochs"`
// The initial learning rate to be used during training
LearningRate *float64 `mandatory:"false" json:"learningRate"`
// The batch size used during training.
TrainingBatchSize *int `mandatory:"false" json:"trainingBatchSize"`
// Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
EarlyStoppingPatience *int `mandatory:"false" json:"earlyStoppingPatience"`
// How much the loss must improve to prevent early stopping.
EarlyStoppingThreshold *float64 `mandatory:"false" json:"earlyStoppingThreshold"`
// Determines how frequently to log model metrics.
// Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
LogModelMetricsIntervalInSteps *int `mandatory:"false" json:"logModelMetricsIntervalInSteps"`
}
func (m TFewTrainingConfig) GetEarlyStoppingPatience() *int
GetEarlyStoppingPatience returns EarlyStoppingPatience
func (m TFewTrainingConfig) GetEarlyStoppingThreshold() *float64
GetEarlyStoppingThreshold returns EarlyStoppingThreshold
func (m TFewTrainingConfig) GetLearningRate() *float64
GetLearningRate returns LearningRate
func (m TFewTrainingConfig) GetLogModelMetricsIntervalInSteps() *int
GetLogModelMetricsIntervalInSteps returns LogModelMetricsIntervalInSteps
func (m TFewTrainingConfig) GetTotalTrainingEpochs() *int
GetTotalTrainingEpochs returns TotalTrainingEpochs
func (m TFewTrainingConfig) GetTrainingBatchSize() *int
GetTrainingBatchSize returns TrainingBatchSize
func (m TFewTrainingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TFewTrainingConfig) String() string
func (m TFewTrainingConfig) 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
TextGenerationModelMetrics The text generation model metrics of the fine-tuning process.
type TextGenerationModelMetrics struct {
// Fine-tuned model accuracy.
FinalAccuracy *float64 `mandatory:"false" json:"finalAccuracy"`
// Fine-tuned model loss.
FinalLoss *float64 `mandatory:"false" json:"finalLoss"`
}
func (m TextGenerationModelMetrics) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextGenerationModelMetrics) String() string
func (m TextGenerationModelMetrics) 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
TrainingConfig The fine-tuning method and hyperparameters used for fine-tuning a custom model.
type TrainingConfig interface {
// The maximum number of training epochs to run for.
GetTotalTrainingEpochs() *int
// The initial learning rate to be used during training
GetLearningRate() *float64
// The batch size used during training.
GetTrainingBatchSize() *int
// Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
GetEarlyStoppingPatience() *int
// How much the loss must improve to prevent early stopping.
GetEarlyStoppingThreshold() *float64
// Determines how frequently to log model metrics.
// Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
GetLogModelMetricsIntervalInSteps() *int
}
TrainingConfigTrainingConfigTypeEnum Enum with underlying type: string
type TrainingConfigTrainingConfigTypeEnum string
Set of constants representing the allowable values for TrainingConfigTrainingConfigTypeEnum
const (
TrainingConfigTrainingConfigTypeTfewTrainingConfig TrainingConfigTrainingConfigTypeEnum = "TFEW_TRAINING_CONFIG"
TrainingConfigTrainingConfigTypeVanillaTrainingConfig TrainingConfigTrainingConfigTypeEnum = "VANILLA_TRAINING_CONFIG"
TrainingConfigTrainingConfigTypeLoraTrainingConfig TrainingConfigTrainingConfigTypeEnum = "LORA_TRAINING_CONFIG"
)
func GetMappingTrainingConfigTrainingConfigTypeEnum(val string) (TrainingConfigTrainingConfigTypeEnum, bool)
GetMappingTrainingConfigTrainingConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTrainingConfigTrainingConfigTypeEnumValues() []TrainingConfigTrainingConfigTypeEnum
GetTrainingConfigTrainingConfigTypeEnumValues Enumerates the set of values for TrainingConfigTrainingConfigTypeEnum
UpdateApiKeyDetails The data to update an API key.
type UpdateApiKeyDetails struct {
// 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 Api key.
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateApiKeyDetails) String() string
func (m UpdateApiKeyDetails) 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
UpdateApiKeyRequest wrapper for the UpdateApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateApiKey.go.html to see an example of how to use UpdateApiKeyRequest.
type UpdateApiKeyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
ApiKeyId *string `mandatory:"true" contributesTo:"path" name:"apiKeyId"`
// The information to be updated.
UpdateApiKeyDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateApiKeyRequest) String() string
func (request UpdateApiKeyRequest) 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
UpdateApiKeyResponse wrapper for the UpdateApiKey operation
type UpdateApiKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiKey instance
ApiKey `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApiKeyResponse) String() string
UpdateDedicatedAiClusterDetails The data to update a dedicated AI cluster.
type UpdateDedicatedAiClusterDetails struct {
// 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 dedicated AI cluster.
Description *string `mandatory:"false" json:"description"`
// The number of dedicated units in this AI cluster.
UnitCount *int `mandatory:"false" json:"unitCount"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDedicatedAiClusterDetails) String() string
func (m UpdateDedicatedAiClusterDetails) 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
UpdateDedicatedAiClusterRequest wrapper for the UpdateDedicatedAiCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateDedicatedAiCluster.go.html to see an example of how to use UpdateDedicatedAiClusterRequest.
type UpdateDedicatedAiClusterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster.
DedicatedAiClusterId *string `mandatory:"true" contributesTo:"path" name:"dedicatedAiClusterId"`
// The information to be updated.
UpdateDedicatedAiClusterDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateDedicatedAiClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDedicatedAiClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDedicatedAiClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDedicatedAiClusterRequest) String() string
func (request UpdateDedicatedAiClusterRequest) 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
UpdateDedicatedAiClusterResponse wrapper for the UpdateDedicatedAiCluster operation
type UpdateDedicatedAiClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DedicatedAiCluster instance
DedicatedAiCluster `presentIn:"body"`
// The OCID (https://docs.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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateDedicatedAiClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDedicatedAiClusterResponse) String() string
UpdateEndpointDetails The data to update an endpoint.
type UpdateEndpointDetails struct {
// 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"`
// The OCID of the Generative AI private endpoint to which this endpoint will be attached.
GenerativeAiPrivateEndpointId *string `mandatory:"false" json:"generativeAiPrivateEndpointId"`
ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`
PromptInjectionConfig *PromptInjectionConfig `mandatory:"false" json:"promptInjectionConfig"`
PiiDetectionConfig *PiiDetectionConfig `mandatory:"false" json:"piiDetectionConfig"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateEndpointDetails) String() string
func (m UpdateEndpointDetails) 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
UpdateEndpointRequest wrapper for the UpdateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateEndpoint.go.html to see an example of how to use UpdateEndpointRequest.
type UpdateEndpointRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// The information to be updated.
UpdateEndpointDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEndpointRequest) String() string
func (request UpdateEndpointRequest) 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
UpdateEndpointResponse wrapper for the UpdateEndpoint operation
type UpdateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The Endpoint instance
Endpoint `presentIn:"body"`
// The OCID (https://docs.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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEndpointResponse) String() string
UpdateGenerativeAiPrivateEndpointDetails The details required to update a Generative AI private endpoint.
type UpdateGenerativeAiPrivateEndpointDetails struct {
// A user friendly description. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// dnsPrefix of the private endpoint FQDN.
DnsPrefix *string `mandatory:"false" json:"dnsPrefix"`
// A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Flag that allows access to on-demand models using this private endpoint.
IsAllowOnDemand *bool `mandatory:"false" json:"isAllowOnDemand"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m UpdateGenerativeAiPrivateEndpointDetails) String() string
func (m UpdateGenerativeAiPrivateEndpointDetails) 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
UpdateGenerativeAiPrivateEndpointRequest wrapper for the UpdateGenerativeAiPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateGenerativeAiPrivateEndpoint.go.html to see an example of how to use UpdateGenerativeAiPrivateEndpointRequest.
type UpdateGenerativeAiPrivateEndpointRequest struct {
// The unique id for a Generative AI private endpoint.
GenerativeAiPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"generativeAiPrivateEndpointId"`
// Details for updating a Generative AI private endpoint.
UpdateGenerativeAiPrivateEndpointDetails `contributesTo:"body"`
// 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 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateGenerativeAiPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGenerativeAiPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGenerativeAiPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGenerativeAiPrivateEndpointRequest) String() string
func (request UpdateGenerativeAiPrivateEndpointRequest) 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
UpdateGenerativeAiPrivateEndpointResponse wrapper for the UpdateGenerativeAiPrivateEndpoint operation
type UpdateGenerativeAiPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerativeAiPrivateEndpoint instance
GenerativeAiPrivateEndpoint `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"`
// The OCID (https://docs.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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateGenerativeAiPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGenerativeAiPrivateEndpointResponse) String() string
UpdateGenerativeAiProjectDetails The data to update a GenerativeAiProject.
type UpdateGenerativeAiProjectDetails struct {
// An optional description of the GenerativeAiProject.
Description *string `mandatory:"false" json:"description"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
ConversationConfig *ConversationConfig `mandatory:"false" json:"conversationConfig"`
LongTermMemoryConfig *LongTermMemoryConfig `mandatory:"false" json:"longTermMemoryConfig"`
ShortTermMemoryOptimizationConfig *ShortTermMemoryOptimizationConfig `mandatory:"false" json:"shortTermMemoryOptimizationConfig"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateGenerativeAiProjectDetails) String() string
func (m UpdateGenerativeAiProjectDetails) 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
UpdateGenerativeAiProjectRequest wrapper for the UpdateGenerativeAiProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateGenerativeAiProject.go.html to see an example of how to use UpdateGenerativeAiProjectRequest.
type UpdateGenerativeAiProjectRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject.
GenerativeAiProjectId *string `mandatory:"true" contributesTo:"path" name:"generativeAiProjectId"`
// The information to be updated.
UpdateGenerativeAiProjectDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateGenerativeAiProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGenerativeAiProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGenerativeAiProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGenerativeAiProjectRequest) String() string
func (request UpdateGenerativeAiProjectRequest) 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
UpdateGenerativeAiProjectResponse wrapper for the UpdateGenerativeAiProject operation
type UpdateGenerativeAiProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerativeAiProject instance
GenerativeAiProject `presentIn:"body"`
// The OCID (https://docs.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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateGenerativeAiProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGenerativeAiProjectResponse) String() string
UpdateHostedApplicationDetails The data to update a hosted application.
type UpdateHostedApplicationDetails struct {
// 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 hosted application.
Description *string `mandatory:"false" json:"description"`
ScalingConfig *ScalingConfig `mandatory:"false" json:"scalingConfig"`
InboundAuthConfig *InboundAuthConfig `mandatory:"false" json:"inboundAuthConfig"`
// The list of environment variables for the Hosted Application.
// Defines a list of environment variables injected at runtime.
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateHostedApplicationDetails) String() string
func (m UpdateHostedApplicationDetails) 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
UpdateHostedApplicationRequest wrapper for the UpdateHostedApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateHostedApplication.go.html to see an example of how to use UpdateHostedApplicationRequest.
type UpdateHostedApplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application.
HostedApplicationId *string `mandatory:"true" contributesTo:"path" name:"hostedApplicationId"`
// The information to be updated.
UpdateHostedApplicationDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateHostedApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHostedApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHostedApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHostedApplicationRequest) String() string
func (request UpdateHostedApplicationRequest) 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
UpdateHostedApplicationResponse wrapper for the UpdateHostedApplication operation
type UpdateHostedApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateHostedApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHostedApplicationResponse) String() string
UpdateHostedDeploymentDetails The data to update a hosted deployment.
type UpdateHostedDeploymentDetails struct {
ActiveArtifact *SingleDockerArtifact `mandatory:"true" json:"activeArtifact"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateHostedDeploymentDetails) String() string
func (m UpdateHostedDeploymentDetails) 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
UpdateHostedDeploymentRequest wrapper for the UpdateHostedDeployment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateHostedDeployment.go.html to see an example of how to use UpdateHostedDeploymentRequest.
type UpdateHostedDeploymentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment.
HostedDeploymentId *string `mandatory:"true" contributesTo:"path" name:"hostedDeploymentId"`
// update hosted deployment.
UpdateHostedDeploymentDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateHostedDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHostedDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHostedDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHostedDeploymentRequest) String() string
func (request UpdateHostedDeploymentRequest) 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
UpdateHostedDeploymentResponse wrapper for the UpdateHostedDeployment operation
type UpdateHostedDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The HostedDeployment instance
HostedDeployment `presentIn:"body"`
// The OCID (https://docs.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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateHostedDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHostedDeploymentResponse) String() string
UpdateImportedModelDetails The data to update an imported model.
type UpdateImportedModelDetails struct {
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the imported model.
Description *string `mandatory:"false" json:"description"`
// The provider of the imported model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the imported model.
Version *string `mandatory:"false" json:"version"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateImportedModelDetails) String() string
func (m UpdateImportedModelDetails) 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
UpdateImportedModelRequest wrapper for the UpdateImportedModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateImportedModel.go.html to see an example of how to use UpdateImportedModelRequest.
type UpdateImportedModelRequest struct {
// The importedModel OCID
ImportedModelId *string `mandatory:"true" contributesTo:"path" name:"importedModelId"`
// The model information to be updated.
UpdateImportedModelDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateImportedModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateImportedModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateImportedModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateImportedModelRequest) String() string
func (request UpdateImportedModelRequest) 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
UpdateImportedModelResponse wrapper for the UpdateImportedModel operation
type UpdateImportedModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportedModel instance
ImportedModel `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateImportedModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateImportedModelResponse) String() string
UpdateModelDetails The data to update a custom model.
type UpdateModelDetails struct {
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional description of the model.
Description *string `mandatory:"false" json:"description"`
// The provider of the base model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the model.
Version *string `mandatory:"false" json:"version"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateModelDetails) String() string
func (m UpdateModelDetails) 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
UpdateModelRequest wrapper for the UpdateModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateModel.go.html to see an example of how to use UpdateModelRequest.
type UpdateModelRequest struct {
// The model OCID
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// The model information to be updated.
UpdateModelDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateModelRequest) String() string
func (request UpdateModelRequest) 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
UpdateModelResponse wrapper for the UpdateModel operation
type UpdateModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateModelResponse) String() string
UpdateSemanticStoreDetails The data to update a SemanticStore.
type UpdateSemanticStoreDetails struct {
// An optional description of the SemanticStore.
Description *string `mandatory:"false" json:"description"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
RefreshSchedule RefreshScheduleDetails `mandatory:"false" json:"refreshSchedule"`
Schemas CreateSchemasDetails `mandatory:"false" json:"schemas"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateSemanticStoreDetails) String() string
func (m *UpdateSemanticStoreDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateSemanticStoreDetails) 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
UpdateSemanticStoreRequest wrapper for the UpdateSemanticStore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateSemanticStore.go.html to see an example of how to use UpdateSemanticStoreRequest.
type UpdateSemanticStoreRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore.
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// The information to be updated.
UpdateSemanticStoreDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateSemanticStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSemanticStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSemanticStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSemanticStoreRequest) String() string
func (request UpdateSemanticStoreRequest) 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
UpdateSemanticStoreResponse wrapper for the UpdateSemanticStore operation
type UpdateSemanticStoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The SemanticStore instance
SemanticStore `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateSemanticStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSemanticStoreResponse) String() string
UpdateVectorStoreConnectorDetails The data to update a VectorStoreConnector.
type UpdateVectorStoreConnectorDetails struct {
// An optional description of the VectorStoreConnector.
Description *string `mandatory:"false" json:"description"`
// A user-friendly name for the VectorStoreConnector.
DisplayName *string `mandatory:"false" json:"displayName"`
ScheduleConfig ScheduleConfig `mandatory:"false" json:"scheduleConfig"`
Configuration ConnectorConfiguration `mandatory:"false" json:"configuration"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateVectorStoreConnectorDetails) String() string
func (m *UpdateVectorStoreConnectorDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateVectorStoreConnectorDetails) 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
UpdateVectorStoreConnectorRequest wrapper for the UpdateVectorStoreConnector operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeai/UpdateVectorStoreConnector.go.html to see an example of how to use UpdateVectorStoreConnectorRequest.
type UpdateVectorStoreConnectorRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VectorStoreConnector.
VectorStoreConnectorId *string `mandatory:"true" contributesTo:"path" name:"vectorStoreConnectorId"`
// The information to be updated.
UpdateVectorStoreConnectorDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateVectorStoreConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateVectorStoreConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateVectorStoreConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateVectorStoreConnectorRequest) String() string
func (request UpdateVectorStoreConnectorRequest) 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
UpdateVectorStoreConnectorResponse wrapper for the UpdateVectorStoreConnector operation
type UpdateVectorStoreConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The VectorStoreConnector instance
VectorStoreConnector `presentIn:"body"`
// The OCID (https://docs.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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateVectorStoreConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateVectorStoreConnectorResponse) String() string
VanillaTrainingConfig The Vanilla training method hyperparameters.
type VanillaTrainingConfig struct {
// The maximum number of training epochs to run for.
TotalTrainingEpochs *int `mandatory:"false" json:"totalTrainingEpochs"`
// The initial learning rate to be used during training
LearningRate *float64 `mandatory:"false" json:"learningRate"`
// The batch size used during training.
TrainingBatchSize *int `mandatory:"false" json:"trainingBatchSize"`
// Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
EarlyStoppingPatience *int `mandatory:"false" json:"earlyStoppingPatience"`
// How much the loss must improve to prevent early stopping.
EarlyStoppingThreshold *float64 `mandatory:"false" json:"earlyStoppingThreshold"`
// Determines how frequently to log model metrics.
// Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
LogModelMetricsIntervalInSteps *int `mandatory:"false" json:"logModelMetricsIntervalInSteps"`
// The number of last layers to be fine-tuned.
NumOfLastLayers *int `mandatory:"false" json:"numOfLastLayers"`
}
func (m VanillaTrainingConfig) GetEarlyStoppingPatience() *int
GetEarlyStoppingPatience returns EarlyStoppingPatience
func (m VanillaTrainingConfig) GetEarlyStoppingThreshold() *float64
GetEarlyStoppingThreshold returns EarlyStoppingThreshold
func (m VanillaTrainingConfig) GetLearningRate() *float64
GetLearningRate returns LearningRate
func (m VanillaTrainingConfig) GetLogModelMetricsIntervalInSteps() *int
GetLogModelMetricsIntervalInSteps returns LogModelMetricsIntervalInSteps
func (m VanillaTrainingConfig) GetTotalTrainingEpochs() *int
GetTotalTrainingEpochs returns TotalTrainingEpochs
func (m VanillaTrainingConfig) GetTrainingBatchSize() *int
GetTrainingBatchSize returns TrainingBatchSize
func (m VanillaTrainingConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VanillaTrainingConfig) String() string
func (m VanillaTrainingConfig) 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
VectorStoreConnector A VectorStore Connector offers a lightweight and configurable mechanism to continuously synchronize data from external systems into the VectorStore at scale. It captures the configuration of the datasource for data ingestion.
type VectorStoreConnector struct {
// An OCID that uniquely identifies a VectorStoreConnector
Id *string `mandatory:"true" json:"id"`
// A user-friendly name
DisplayName *string `mandatory:"true" json:"displayName"`
// An OCID that identifies the Vector Store to which this connector is connected.
VectorStoreId *string `mandatory:"true" json:"vectorStoreId"`
// Owning compartment OCID for a VectorStoreConnector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Owning tenant OCID for a VectorStoreConnector
TenantId *string `mandatory:"true" json:"tenantId"`
// The date and time that the VectorStoreConnector was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The lifecycle state of a VectorStoreConnector.
LifecycleState VectorStoreConnectorLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
Configuration ConnectorConfiguration `mandatory:"true" json:"configuration"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" 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:"true" json:"systemTags"`
// An optional description of the VectorStoreConnector
Description *string `mandatory:"false" json:"description"`
// The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// An optional customer Encryption Key stored in OCI Vault that can be used to decrypt the data downloaded from the data source.
VaultSecretId *string `mandatory:"false" json:"vaultSecretId"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
ScheduleConfig ScheduleConfig `mandatory:"false" json:"scheduleConfig"`
}
func (m VectorStoreConnector) String() string
func (m *VectorStoreConnector) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m VectorStoreConnector) 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
VectorStoreConnectorCollection Results of a VectorStoreConnector search. Contains VectorStoreConnectorSummary items.
type VectorStoreConnectorCollection struct {
// List of VectorStoreConnector objects.
Items []VectorStoreConnectorSummary `mandatory:"true" json:"items"`
}
func (m VectorStoreConnectorCollection) String() string
func (m VectorStoreConnectorCollection) 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
VectorStoreConnectorFileSync The VectorStoreConnectorFileSync is an operation that carries out the data sync operation between the datasource and the VectorStore. The FileSync can be triggered either manually or at a scheduled interval by the VectorStoreConnector.
type VectorStoreConnectorFileSync struct {
// An OCID that uniquely identifies a VectorStoreConnectorFileSync operation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name.
DisplayName *string `mandatory:"true" json:"displayName"`
// An OCID that identifies the VectorStoreConnector under which this FileSync operation is created.
VectorStoreConnectorId *string `mandatory:"true" json:"vectorStoreConnectorId"`
// Owning compartment OCID for a VectorStoreConnectorFileSync.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Owning tenant OCID for a VectorStoreConnector
TenantId *string `mandatory:"true" json:"tenantId"`
// The date and time that the FileSync operation was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the VectorStoreConnectorFileSync operation.
LifecycleState VectorStoreConnectorFileSyncLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The type of the FileSync operation based on how it is triggered. The type can be either MANUAL or SCHEDULED
TriggerType VectorStoreConnectorFileSyncTriggerTypeEnum `mandatory:"true" json:"triggerType"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" 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:"true" json:"systemTags"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time when the FileSync operation has started in the format of an RFC3339 datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time when the FileSync operation has ended in the format of an RFC3339 datetime string.
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The total time taken (in seconds) for the VectorStoreConnectorFileSync operation.
DurationInSeconds *int `mandatory:"false" json:"durationInSeconds"`
Stats *VectorStoreConnectorStats `mandatory:"false" json:"stats"`
}
func (m VectorStoreConnectorFileSync) String() string
func (m VectorStoreConnectorFileSync) 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
VectorStoreConnectorFileSyncCollection Results of a VectorStoreConnectorFileSync search.
type VectorStoreConnectorFileSyncCollection struct {
// List of VectorStoreConnectorFileSync operations.
Items []VectorStoreConnectorFileSyncSummary `mandatory:"true" json:"items"`
}
func (m VectorStoreConnectorFileSyncCollection) String() string
func (m VectorStoreConnectorFileSyncCollection) 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
VectorStoreConnectorFileSyncLifecycleStateEnum Enum with underlying type: string
type VectorStoreConnectorFileSyncLifecycleStateEnum string
Set of constants representing the allowable values for VectorStoreConnectorFileSyncLifecycleStateEnum
const (
VectorStoreConnectorFileSyncLifecycleStateAccepted VectorStoreConnectorFileSyncLifecycleStateEnum = "ACCEPTED"
VectorStoreConnectorFileSyncLifecycleStateInProgress VectorStoreConnectorFileSyncLifecycleStateEnum = "IN_PROGRESS"
VectorStoreConnectorFileSyncLifecycleStateFailed VectorStoreConnectorFileSyncLifecycleStateEnum = "FAILED"
VectorStoreConnectorFileSyncLifecycleStateSucceeded VectorStoreConnectorFileSyncLifecycleStateEnum = "SUCCEEDED"
VectorStoreConnectorFileSyncLifecycleStateCanceling VectorStoreConnectorFileSyncLifecycleStateEnum = "CANCELING"
VectorStoreConnectorFileSyncLifecycleStateCanceled VectorStoreConnectorFileSyncLifecycleStateEnum = "CANCELED"
)
func GetMappingVectorStoreConnectorFileSyncLifecycleStateEnum(val string) (VectorStoreConnectorFileSyncLifecycleStateEnum, bool)
GetMappingVectorStoreConnectorFileSyncLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVectorStoreConnectorFileSyncLifecycleStateEnumValues() []VectorStoreConnectorFileSyncLifecycleStateEnum
GetVectorStoreConnectorFileSyncLifecycleStateEnumValues Enumerates the set of values for VectorStoreConnectorFileSyncLifecycleStateEnum
VectorStoreConnectorFileSyncSummary Summary information for a VectorStoreConnectorFileSync
type VectorStoreConnectorFileSyncSummary struct {
// An OCID that uniquely identifies a VectorStoreConnectorFileSync operation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name.
DisplayName *string `mandatory:"true" json:"displayName"`
// An OCID that identifies the VectorStoreConnector under which this FileSync operation is created.
VectorStoreConnectorId *string `mandatory:"true" json:"vectorStoreConnectorId"`
// Owning compartment OCID for a VectorStoreConnectorFileSync.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Owning tenant OCID for a VectorStoreConnector
TenantId *string `mandatory:"true" json:"tenantId"`
// The date and time that the FileSync operation was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the VectorStoreConnectorFileSync operation.
// Accepted Values are:
// - ACCEPTED
// - IN_PROGRESS
// - FAILED
// - SUCCEEDED
// - CANCELING
// - CANCELED
LifecycleState VectorStoreConnectorFileSyncLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The type of the FileSync operation based on how it is triggered. The type can be either MANUAL or SCHEDULED
TriggerType VectorStoreConnectorFileSyncSummaryTriggerTypeEnum `mandatory:"true" json:"triggerType"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" 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:"true" json:"systemTags"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time when the FileSync operation has started in the format of an RFC3339 datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time when the FileSync operation has ended in the format of an RFC3339 datetime string.
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The duration (in seconds) taken for the VectorStoreConnectorFileSync operation to complete.
DurationInSeconds *int `mandatory:"false" json:"durationInSeconds"`
Stats *VectorStoreConnectorStats `mandatory:"false" json:"stats"`
}
func (m VectorStoreConnectorFileSyncSummary) String() string
func (m VectorStoreConnectorFileSyncSummary) 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
VectorStoreConnectorFileSyncSummaryTriggerTypeEnum Enum with underlying type: string
type VectorStoreConnectorFileSyncSummaryTriggerTypeEnum string
Set of constants representing the allowable values for VectorStoreConnectorFileSyncSummaryTriggerTypeEnum
const (
VectorStoreConnectorFileSyncSummaryTriggerTypeManual VectorStoreConnectorFileSyncSummaryTriggerTypeEnum = "MANUAL"
VectorStoreConnectorFileSyncSummaryTriggerTypeScheduled VectorStoreConnectorFileSyncSummaryTriggerTypeEnum = "SCHEDULED"
)
func GetMappingVectorStoreConnectorFileSyncSummaryTriggerTypeEnum(val string) (VectorStoreConnectorFileSyncSummaryTriggerTypeEnum, bool)
GetMappingVectorStoreConnectorFileSyncSummaryTriggerTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVectorStoreConnectorFileSyncSummaryTriggerTypeEnumValues() []VectorStoreConnectorFileSyncSummaryTriggerTypeEnum
GetVectorStoreConnectorFileSyncSummaryTriggerTypeEnumValues Enumerates the set of values for VectorStoreConnectorFileSyncSummaryTriggerTypeEnum
VectorStoreConnectorFileSyncTriggerTypeEnum Enum with underlying type: string
type VectorStoreConnectorFileSyncTriggerTypeEnum string
Set of constants representing the allowable values for VectorStoreConnectorFileSyncTriggerTypeEnum
const (
VectorStoreConnectorFileSyncTriggerTypeManual VectorStoreConnectorFileSyncTriggerTypeEnum = "MANUAL"
VectorStoreConnectorFileSyncTriggerTypeScheduled VectorStoreConnectorFileSyncTriggerTypeEnum = "SCHEDULED"
)
func GetMappingVectorStoreConnectorFileSyncTriggerTypeEnum(val string) (VectorStoreConnectorFileSyncTriggerTypeEnum, bool)
GetMappingVectorStoreConnectorFileSyncTriggerTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVectorStoreConnectorFileSyncTriggerTypeEnumValues() []VectorStoreConnectorFileSyncTriggerTypeEnum
GetVectorStoreConnectorFileSyncTriggerTypeEnumValues Enumerates the set of values for VectorStoreConnectorFileSyncTriggerTypeEnum
VectorStoreConnectorIngestionLogs A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector
type VectorStoreConnectorIngestionLogs struct {
// An identifier that identifies a File ingested to a VectorStore.
FileId *string `mandatory:"true" json:"fileId"`
// The path where the file was located in the datasource.
FilePath *string `mandatory:"true" json:"filePath"`
// The current status of ingestion for the File
Status VectorStoreConnectorIngestionLogsStatusEnum `mandatory:"true" json:"status"`
// An identifier that identifies the FileSync operation that added this file for ingestion.
VectorStoreConnectorFileSyncId *string `mandatory:"false" json:"vectorStoreConnectorFileSyncId"`
// The size of the file.
FileSizeInBytes *int `mandatory:"false" json:"fileSizeInBytes"`
// The total number of chunks created from the File.
TotalChunksCreated *int `mandatory:"false" json:"totalChunksCreated"`
// The duration taken(in seconds) to ingest the File.
DurationInSeconds *int `mandatory:"false" json:"durationInSeconds"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m VectorStoreConnectorIngestionLogs) String() string
func (m VectorStoreConnectorIngestionLogs) 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
VectorStoreConnectorIngestionLogsCollection Results of a VectorStoreConnector Ingestion Log search.
type VectorStoreConnectorIngestionLogsCollection struct {
// List of VectorStoreConnectorIngestionLogs objects.
Items []VectorStoreConnectorIngestionLogs `mandatory:"true" json:"items"`
}
func (m VectorStoreConnectorIngestionLogsCollection) String() string
func (m VectorStoreConnectorIngestionLogsCollection) 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
VectorStoreConnectorIngestionLogsStatusEnum Enum with underlying type: string
type VectorStoreConnectorIngestionLogsStatusEnum string
Set of constants representing the allowable values for VectorStoreConnectorIngestionLogsStatusEnum
const (
VectorStoreConnectorIngestionLogsStatusCompleted VectorStoreConnectorIngestionLogsStatusEnum = "COMPLETED"
VectorStoreConnectorIngestionLogsStatusCancelled VectorStoreConnectorIngestionLogsStatusEnum = "CANCELLED"
VectorStoreConnectorIngestionLogsStatusFailed VectorStoreConnectorIngestionLogsStatusEnum = "FAILED"
VectorStoreConnectorIngestionLogsStatusQueued VectorStoreConnectorIngestionLogsStatusEnum = "QUEUED"
VectorStoreConnectorIngestionLogsStatusInProgress VectorStoreConnectorIngestionLogsStatusEnum = "IN_PROGRESS"
)
func GetMappingVectorStoreConnectorIngestionLogsStatusEnum(val string) (VectorStoreConnectorIngestionLogsStatusEnum, bool)
GetMappingVectorStoreConnectorIngestionLogsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVectorStoreConnectorIngestionLogsStatusEnumValues() []VectorStoreConnectorIngestionLogsStatusEnum
GetVectorStoreConnectorIngestionLogsStatusEnumValues Enumerates the set of values for VectorStoreConnectorIngestionLogsStatusEnum
VectorStoreConnectorLifecycleStateEnum Enum with underlying type: string
type VectorStoreConnectorLifecycleStateEnum string
Set of constants representing the allowable values for VectorStoreConnectorLifecycleStateEnum
const (
VectorStoreConnectorLifecycleStateActive VectorStoreConnectorLifecycleStateEnum = "ACTIVE"
VectorStoreConnectorLifecycleStateCreating VectorStoreConnectorLifecycleStateEnum = "CREATING"
VectorStoreConnectorLifecycleStateUpdating VectorStoreConnectorLifecycleStateEnum = "UPDATING"
VectorStoreConnectorLifecycleStateDeleting VectorStoreConnectorLifecycleStateEnum = "DELETING"
VectorStoreConnectorLifecycleStateDeleted VectorStoreConnectorLifecycleStateEnum = "DELETED"
VectorStoreConnectorLifecycleStateFailed VectorStoreConnectorLifecycleStateEnum = "FAILED"
)
func GetMappingVectorStoreConnectorLifecycleStateEnum(val string) (VectorStoreConnectorLifecycleStateEnum, bool)
GetMappingVectorStoreConnectorLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVectorStoreConnectorLifecycleStateEnumValues() []VectorStoreConnectorLifecycleStateEnum
GetVectorStoreConnectorLifecycleStateEnumValues Enumerates the set of values for VectorStoreConnectorLifecycleStateEnum
VectorStoreConnectorStats File synchronization statistics for a VectorStoreConnector.
type VectorStoreConnectorStats struct {
// The date and time when the statistics was generated in the format of an RFC3339 datetime string.
TimeGenerated *common.SDKTime `mandatory:"true" json:"timeGenerated"`
Created *FileSyncStatistics `mandatory:"false" json:"created"`
Updated *FileSyncStatistics `mandatory:"false" json:"updated"`
Deleted *FileSyncStatistics `mandatory:"false" json:"deleted"`
MetadataUpdated *FileSyncStatistics `mandatory:"false" json:"metadataUpdated"`
Ignored *FileSyncStatistics `mandatory:"false" json:"ignored"`
Unsupported *FileSyncStatistics `mandatory:"false" json:"unsupported"`
InProgress *FileSyncStatistics `mandatory:"false" json:"inProgress"`
Failed *FileSyncStatistics `mandatory:"false" json:"failed"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m VectorStoreConnectorStats) String() string
func (m VectorStoreConnectorStats) 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
VectorStoreConnectorSummary Summary information for a VectorStoreConnector
type VectorStoreConnectorSummary struct {
// An OCID that uniquely identifies a VectorStoreConnector
Id *string `mandatory:"true" json:"id"`
// A user-friendly name
DisplayName *string `mandatory:"true" json:"displayName"`
// An OCID that identifies the Vector Store to which this connector is connected.
VectorStoreId *string `mandatory:"true" json:"vectorStoreId"`
// Owning compartment OCID for a VectorStoreConnector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Owning tenant OCID for a VectorStoreConnector
TenantId *string `mandatory:"true" json:"tenantId"`
// The date and time that the VectorStoreConnector was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The lifecycle state of a VectorStoreConnector.
// Allowed values are:
// - ACTIVE
// - CREATING
// - UPDATING
// - DELETING
// - DELETED
// - FAILED
LifecycleState VectorStoreConnectorLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
Configuration ConnectorConfiguration `mandatory:"true" json:"configuration"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" 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:"true" json:"systemTags"`
// An optional description of the VectorStoreConnector
Description *string `mandatory:"false" json:"description"`
// The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
ScheduleConfig ScheduleConfig `mandatory:"false" json:"scheduleConfig"`
}
func (m VectorStoreConnectorSummary) String() string
func (m *VectorStoreConnectorSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m VectorStoreConnectorSummary) 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
WorkRequest An asynchronous work request. When you start a long-running operation, the service creates a work request. Work requests help you monitor long-running operations. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while performing an operation that is tracked by this work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.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 that the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection A list of work request errors. Can contain errors and other information such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry The log message from performing an operation that is tracked by this work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection A list of work request logs. Can contain logs and other information such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource The resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection A list of work requests. Can contain work requests and other information such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly