generativeai

package
v65.71.1 Latest Latest
Warning

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

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

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetActionTypeEnumStringValues ¶ 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetDatasetDatasetTypeEnumStringValues ¶ 

func GetDatasetDatasetTypeEnumStringValues() []string

GetDatasetDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDatasetTypeEnum

func GetDedicatedAiClusterCapacityCapacityTypeEnumStringValues ¶ 

func GetDedicatedAiClusterCapacityCapacityTypeEnumStringValues() []string

GetDedicatedAiClusterCapacityCapacityTypeEnumStringValues Enumerates the set of values in String for DedicatedAiClusterCapacityCapacityTypeEnum

func GetDedicatedAiClusterLifecycleStateEnumStringValues ¶ 

func GetDedicatedAiClusterLifecycleStateEnumStringValues() []string

GetDedicatedAiClusterLifecycleStateEnumStringValues Enumerates the set of values in String for DedicatedAiClusterLifecycleStateEnum

func GetDedicatedAiClusterTypeEnumStringValues ¶ 

func GetDedicatedAiClusterTypeEnumStringValues() []string

GetDedicatedAiClusterTypeEnumStringValues Enumerates the set of values in String for DedicatedAiClusterTypeEnum

func GetDedicatedAiClusterUnitShapeEnumStringValues ¶ 

func GetDedicatedAiClusterUnitShapeEnumStringValues() []string

GetDedicatedAiClusterUnitShapeEnumStringValues Enumerates the set of values in String for DedicatedAiClusterUnitShapeEnum

func GetEndpointLifecycleStateEnumStringValues ¶ 

func GetEndpointLifecycleStateEnumStringValues() []string

GetEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for EndpointLifecycleStateEnum

func GetListDedicatedAiClustersSortByEnumStringValues ¶ 

func GetListDedicatedAiClustersSortByEnumStringValues() []string

GetListDedicatedAiClustersSortByEnumStringValues Enumerates the set of values in String for ListDedicatedAiClustersSortByEnum

func GetListDedicatedAiClustersSortOrderEnumStringValues ¶ 

func GetListDedicatedAiClustersSortOrderEnumStringValues() []string

GetListDedicatedAiClustersSortOrderEnumStringValues Enumerates the set of values in String for ListDedicatedAiClustersSortOrderEnum

func GetListEndpointsSortByEnumStringValues ¶ 

func GetListEndpointsSortByEnumStringValues() []string

GetListEndpointsSortByEnumStringValues Enumerates the set of values in String for ListEndpointsSortByEnum

func GetListEndpointsSortOrderEnumStringValues ¶ 

func GetListEndpointsSortOrderEnumStringValues() []string

GetListEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListEndpointsSortOrderEnum

func GetListModelsSortByEnumStringValues ¶ 

func GetListModelsSortByEnumStringValues() []string

GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum

func GetListModelsSortOrderEnumStringValues ¶ 

func GetListModelsSortOrderEnumStringValues() []string

GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues ¶ 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues ¶ 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues ¶ 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues ¶ 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues ¶ 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues ¶ 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues ¶ 

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetModelCapabilityEnumStringValues ¶ 

func GetModelCapabilityEnumStringValues() []string

GetModelCapabilityEnumStringValues Enumerates the set of values in String for ModelCapabilityEnum

func GetModelLifecycleStateEnumStringValues ¶ 

func GetModelLifecycleStateEnumStringValues() []string

GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum

func GetModelMetricsModelMetricsTypeEnumStringValues ¶ 

func GetModelMetricsModelMetricsTypeEnumStringValues() []string

GetModelMetricsModelMetricsTypeEnumStringValues Enumerates the set of values in String for ModelMetricsModelMetricsTypeEnum

func GetModelTypeEnumStringValues ¶ 

func GetModelTypeEnumStringValues() []string

GetModelTypeEnumStringValues Enumerates the set of values in String for ModelTypeEnum

func GetOperationStatusEnumStringValues ¶ 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues ¶ 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetSortOrderEnumStringValues ¶ 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetTrainingConfigTrainingConfigTypeEnumStringValues ¶ 

func GetTrainingConfigTrainingConfigTypeEnumStringValues() []string

GetTrainingConfigTrainingConfigTypeEnumStringValues Enumerates the set of values in String for TrainingConfigTrainingConfigTypeEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues ¶ 

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types ¶

type ActionTypeEnum ¶ 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues ¶ 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum ¶ 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type ChangeDedicatedAiClusterCompartmentDetails ¶ 

type ChangeDedicatedAiClusterCompartmentDetails struct {

	// The OCID of the compartment to move the dedicated AI cluster to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeDedicatedAiClusterCompartmentDetails The details to move a dedicated AI cluster to another compartment.

func (ChangeDedicatedAiClusterCompartmentDetails) String ¶ 

func (m ChangeDedicatedAiClusterCompartmentDetails) String() string

func (ChangeDedicatedAiClusterCompartmentDetails) ValidateEnumValue ¶ 

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

type ChangeDedicatedAiClusterCompartmentRequest ¶ 

type ChangeDedicatedAiClusterCompartmentRequest struct {

	// The OCID (https://docs.cloud.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
}

ChangeDedicatedAiClusterCompartmentRequest wrapper for the ChangeDedicatedAiClusterCompartment operation

See also ¶

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

func (ChangeDedicatedAiClusterCompartmentRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeDedicatedAiClusterCompartmentRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ChangeDedicatedAiClusterCompartmentRequest) RetryPolicy ¶ 

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

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

func (ChangeDedicatedAiClusterCompartmentRequest) String ¶ 

func (request ChangeDedicatedAiClusterCompartmentRequest) String() string

func (ChangeDedicatedAiClusterCompartmentRequest) ValidateEnumValue ¶ 

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

type ChangeDedicatedAiClusterCompartmentResponse ¶ 

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

ChangeDedicatedAiClusterCompartmentResponse wrapper for the ChangeDedicatedAiClusterCompartment operation

func (ChangeDedicatedAiClusterCompartmentResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ChangeDedicatedAiClusterCompartmentResponse) String ¶ 

func (response ChangeDedicatedAiClusterCompartmentResponse) String() string

type ChangeEndpointCompartmentDetails ¶ 

type ChangeEndpointCompartmentDetails struct {

	// The OCID of the compartment to move the endpoint to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeEndpointCompartmentDetails The details to move an endpoint to another compartment.

func (ChangeEndpointCompartmentDetails) String ¶ 

func (m ChangeEndpointCompartmentDetails) String() string

func (ChangeEndpointCompartmentDetails) ValidateEnumValue ¶ 

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

type ChangeEndpointCompartmentRequest ¶ 

type ChangeEndpointCompartmentRequest struct {

	// The OCID (https://docs.cloud.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
}

ChangeEndpointCompartmentRequest wrapper for the ChangeEndpointCompartment operation

See also ¶

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

func (ChangeEndpointCompartmentRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeEndpointCompartmentRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ChangeEndpointCompartmentRequest) RetryPolicy ¶ 

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

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

func (ChangeEndpointCompartmentRequest) String ¶ 

func (request ChangeEndpointCompartmentRequest) String() string

func (ChangeEndpointCompartmentRequest) ValidateEnumValue ¶ 

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

type ChangeEndpointCompartmentResponse ¶ 

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

ChangeEndpointCompartmentResponse wrapper for the ChangeEndpointCompartment operation

func (ChangeEndpointCompartmentResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ChangeEndpointCompartmentResponse) String ¶ 

func (response ChangeEndpointCompartmentResponse) String() string

type ChangeModelCompartmentDetails ¶ 

type ChangeModelCompartmentDetails struct {

	// The compartment OCID to create the model in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeModelCompartmentDetails The details to move a custom model to another compartment.

func (ChangeModelCompartmentDetails) String ¶ 

func (m ChangeModelCompartmentDetails) String() string

func (ChangeModelCompartmentDetails) ValidateEnumValue ¶ 

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

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

ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation

See also ¶

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

func (ChangeModelCompartmentRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeModelCompartmentRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ChangeModelCompartmentRequest) RetryPolicy ¶ 

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

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

func (ChangeModelCompartmentRequest) String ¶ 

func (request ChangeModelCompartmentRequest) String() string

func (ChangeModelCompartmentRequest) ValidateEnumValue ¶ 

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

type ChangeModelCompartmentResponse ¶ 

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

ChangeModelCompartmentResponse wrapper for the ChangeModelCompartment operation

func (ChangeModelCompartmentResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ChangeModelCompartmentResponse) String ¶ 

func (response ChangeModelCompartmentResponse) String() string

type ChatModelMetrics ¶ added in v65.67.0 

type ChatModelMetrics struct {

	// Fine-tuned model accuracy.
	FinalAccuracy *float64 `mandatory:"false" json:"finalAccuracy"`

	// Fine-tuned model loss.
	FinalLoss *float64 `mandatory:"false" json:"finalLoss"`
}

ChatModelMetrics The chat model metrics of the fine-tuning process.

func (ChatModelMetrics) MarshalJSON ¶ added in v65.67.0 

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

MarshalJSON marshals to json representation

func (ChatModelMetrics) String ¶ added in v65.67.0 

func (m ChatModelMetrics) String() string

func (ChatModelMetrics) ValidateEnumValue ¶ added in v65.67.0 

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

type ContentModerationConfig ¶ 

type ContentModerationConfig struct {

	// Whether to enable the content moderation feature.
	IsEnabled *bool `mandatory:"true" json:"isEnabled"`
}

ContentModerationConfig The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.

func (ContentModerationConfig) String ¶ 

func (m ContentModerationConfig) String() string

func (ContentModerationConfig) ValidateEnumValue ¶ 

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

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

type CreateDedicatedAiClusterDetails ¶ 

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
	// - EMBED_COHERE
	// - LLAMA2_70
	// - LARGE_GENERIC
	// - LARGE_COHERE_V2_2
	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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDedicatedAiClusterDetails The data to create a dedicated AI cluster.

func (CreateDedicatedAiClusterDetails) String ¶ 

func (m CreateDedicatedAiClusterDetails) String() string

func (CreateDedicatedAiClusterDetails) ValidateEnumValue ¶ 

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

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

CreateDedicatedAiClusterRequest wrapper for the CreateDedicatedAiCluster operation

See also ¶

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

func (CreateDedicatedAiClusterRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateDedicatedAiClusterRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CreateDedicatedAiClusterRequest) RetryPolicy ¶ 

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

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

func (CreateDedicatedAiClusterRequest) String ¶ 

func (request CreateDedicatedAiClusterRequest) String() string

func (CreateDedicatedAiClusterRequest) ValidateEnumValue ¶ 

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

type CreateDedicatedAiClusterResponse ¶ 

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateDedicatedAiClusterResponse wrapper for the CreateDedicatedAiCluster operation

func (CreateDedicatedAiClusterResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CreateDedicatedAiClusterResponse) String ¶ 

func (response CreateDedicatedAiClusterResponse) String() string

type CreateEndpointDetails ¶ 

type CreateEndpointDetails struct {

	// The compartment OCID to create the endpoint in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The ID 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"`

	ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateEndpointDetails The data to create an endpoint.

func (CreateEndpointDetails) String ¶ 

func (m CreateEndpointDetails) String() string

func (CreateEndpointDetails) ValidateEnumValue ¶ 

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

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

CreateEndpointRequest wrapper for the CreateEndpoint operation

See also ¶

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

func (CreateEndpointRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateEndpointRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CreateEndpointRequest) RetryPolicy ¶ 

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

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

func (CreateEndpointRequest) String ¶ 

func (request CreateEndpointRequest) String() string

func (CreateEndpointRequest) ValidateEnumValue ¶ 

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

type CreateEndpointResponse ¶ 

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateEndpointResponse wrapper for the CreateEndpoint operation

func (CreateEndpointResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CreateEndpointResponse) String ¶ 

func (response CreateEndpointResponse) String() string

type CreateModelDetails ¶ 

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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateModelDetails The data to create a custom model.

func (CreateModelDetails) String ¶ 

func (m CreateModelDetails) String() string

func (CreateModelDetails) ValidateEnumValue ¶ 

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

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

CreateModelRequest wrapper for the CreateModel operation

See also ¶

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

func (CreateModelRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateModelRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CreateModelRequest) RetryPolicy ¶ 

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

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

func (CreateModelRequest) String ¶ 

func (request CreateModelRequest) String() string

func (CreateModelRequest) ValidateEnumValue ¶ 

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

type CreateModelResponse ¶ 

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateModelResponse wrapper for the CreateModel operation

func (CreateModelResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CreateModelResponse) String ¶ 

func (response CreateModelResponse) String() string

type Dataset ¶ 

type Dataset interface {
}

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 DatasetDatasetTypeEnum ¶ 

type DatasetDatasetTypeEnum string

DatasetDatasetTypeEnum Enum with underlying type: string 

const (
	DatasetDatasetTypeObjectStorage DatasetDatasetTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for DatasetDatasetTypeEnum

func GetDatasetDatasetTypeEnumValues ¶ 

func GetDatasetDatasetTypeEnumValues() []DatasetDatasetTypeEnum

GetDatasetDatasetTypeEnumValues Enumerates the set of values for DatasetDatasetTypeEnum

func GetMappingDatasetDatasetTypeEnum ¶ 

func GetMappingDatasetDatasetTypeEnum(val string) (DatasetDatasetTypeEnum, bool)

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

type DedicatedAiCluster ¶ 

type DedicatedAiCluster struct {

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resouces (https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).

func (DedicatedAiCluster) String ¶ 

func (m DedicatedAiCluster) String() string

func (*DedicatedAiCluster) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

func (DedicatedAiCluster) ValidateEnumValue ¶ 

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

type DedicatedAiClusterCapacity ¶ 

type DedicatedAiClusterCapacity interface {
}

DedicatedAiClusterCapacity The total capacity for a dedicated AI cluster.

type DedicatedAiClusterCapacityCapacityTypeEnum ¶ 

type DedicatedAiClusterCapacityCapacityTypeEnum string

DedicatedAiClusterCapacityCapacityTypeEnum Enum with underlying type: string 

const (
	DedicatedAiClusterCapacityCapacityTypeHostingCapacity DedicatedAiClusterCapacityCapacityTypeEnum = "HOSTING_CAPACITY"
)

Set of constants representing the allowable values for DedicatedAiClusterCapacityCapacityTypeEnum

func GetDedicatedAiClusterCapacityCapacityTypeEnumValues ¶ 

func GetDedicatedAiClusterCapacityCapacityTypeEnumValues() []DedicatedAiClusterCapacityCapacityTypeEnum

GetDedicatedAiClusterCapacityCapacityTypeEnumValues Enumerates the set of values for DedicatedAiClusterCapacityCapacityTypeEnum

func GetMappingDedicatedAiClusterCapacityCapacityTypeEnum ¶ 

func GetMappingDedicatedAiClusterCapacityCapacityTypeEnum(val string) (DedicatedAiClusterCapacityCapacityTypeEnum, bool)

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

type DedicatedAiClusterCollection ¶ 

type DedicatedAiClusterCollection struct {

	// List of dedicated AI clusters.
	Items []DedicatedAiClusterSummary `mandatory:"true" json:"items"`
}

DedicatedAiClusterCollection Results of a dedicate AI cluster search. Contains DedicatedAiClusterSummary items and other information such as metadata.

func (DedicatedAiClusterCollection) String ¶ 

func (m DedicatedAiClusterCollection) String() string

func (DedicatedAiClusterCollection) ValidateEnumValue ¶ 

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

type DedicatedAiClusterHostingCapacity ¶ 

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

DedicatedAiClusterHostingCapacity The capacity of a hosting type dedicated AI cluster.

func (DedicatedAiClusterHostingCapacity) MarshalJSON ¶ 

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

MarshalJSON marshals to json representation

func (DedicatedAiClusterHostingCapacity) String ¶ 

func (m DedicatedAiClusterHostingCapacity) String() string

func (DedicatedAiClusterHostingCapacity) ValidateEnumValue ¶ 

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

type DedicatedAiClusterLifecycleStateEnum ¶ 

type DedicatedAiClusterLifecycleStateEnum string

DedicatedAiClusterLifecycleStateEnum Enum with underlying type: string 

const (
	DedicatedAiClusterLifecycleStateCreating       DedicatedAiClusterLifecycleStateEnum = "CREATING"
	DedicatedAiClusterLifecycleStateActive         DedicatedAiClusterLifecycleStateEnum = "ACTIVE"
	DedicatedAiClusterLifecycleStateUpdating       DedicatedAiClusterLifecycleStateEnum = "UPDATING"
	DedicatedAiClusterLifecycleStateDeleting       DedicatedAiClusterLifecycleStateEnum = "DELETING"
	DedicatedAiClusterLifecycleStateDeleted        DedicatedAiClusterLifecycleStateEnum = "DELETED"
	DedicatedAiClusterLifecycleStateFailed         DedicatedAiClusterLifecycleStateEnum = "FAILED"
	DedicatedAiClusterLifecycleStateNeedsAttention DedicatedAiClusterLifecycleStateEnum = "NEEDS_ATTENTION"
)

Set of constants representing the allowable values for DedicatedAiClusterLifecycleStateEnum

func GetDedicatedAiClusterLifecycleStateEnumValues ¶ 

func GetDedicatedAiClusterLifecycleStateEnumValues() []DedicatedAiClusterLifecycleStateEnum

GetDedicatedAiClusterLifecycleStateEnumValues Enumerates the set of values for DedicatedAiClusterLifecycleStateEnum

func GetMappingDedicatedAiClusterLifecycleStateEnum ¶ 

func GetMappingDedicatedAiClusterLifecycleStateEnum(val string) (DedicatedAiClusterLifecycleStateEnum, bool)

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

type DedicatedAiClusterSummary ¶ 

type DedicatedAiClusterSummary struct {

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

DedicatedAiClusterSummary Summary information about a dedicated AI cluster.

func (DedicatedAiClusterSummary) String ¶ 

func (m DedicatedAiClusterSummary) String() string

func (*DedicatedAiClusterSummary) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

func (DedicatedAiClusterSummary) ValidateEnumValue ¶ 

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

type DedicatedAiClusterTypeEnum ¶ 

type DedicatedAiClusterTypeEnum string

DedicatedAiClusterTypeEnum Enum with underlying type: string 

const (
	DedicatedAiClusterTypeHosting    DedicatedAiClusterTypeEnum = "HOSTING"
	DedicatedAiClusterTypeFineTuning DedicatedAiClusterTypeEnum = "FINE_TUNING"
)

Set of constants representing the allowable values for DedicatedAiClusterTypeEnum

func GetDedicatedAiClusterTypeEnumValues ¶ 

func GetDedicatedAiClusterTypeEnumValues() []DedicatedAiClusterTypeEnum

GetDedicatedAiClusterTypeEnumValues Enumerates the set of values for DedicatedAiClusterTypeEnum

func GetMappingDedicatedAiClusterTypeEnum ¶ 

func GetMappingDedicatedAiClusterTypeEnum(val string) (DedicatedAiClusterTypeEnum, bool)

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

type DedicatedAiClusterUnitShapeEnum ¶ 

type DedicatedAiClusterUnitShapeEnum string

DedicatedAiClusterUnitShapeEnum Enum with underlying type: string 

const (
	DedicatedAiClusterUnitShapeLargeCohere    DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE"
	DedicatedAiClusterUnitShapeLargeCohereV2  DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE_V2"
	DedicatedAiClusterUnitShapeSmallCohere    DedicatedAiClusterUnitShapeEnum = "SMALL_COHERE"
	DedicatedAiClusterUnitShapeSmallCohereV2  DedicatedAiClusterUnitShapeEnum = "SMALL_COHERE_V2"
	DedicatedAiClusterUnitShapeEmbedCohere    DedicatedAiClusterUnitShapeEnum = "EMBED_COHERE"
	DedicatedAiClusterUnitShapeLlama270       DedicatedAiClusterUnitShapeEnum = "LLAMA2_70"
	DedicatedAiClusterUnitShapeLargeGeneric   DedicatedAiClusterUnitShapeEnum = "LARGE_GENERIC"
	DedicatedAiClusterUnitShapeLargeCohereV22 DedicatedAiClusterUnitShapeEnum = "LARGE_COHERE_V2_2"
)

Set of constants representing the allowable values for DedicatedAiClusterUnitShapeEnum

func GetDedicatedAiClusterUnitShapeEnumValues ¶ 

func GetDedicatedAiClusterUnitShapeEnumValues() []DedicatedAiClusterUnitShapeEnum

GetDedicatedAiClusterUnitShapeEnumValues Enumerates the set of values for DedicatedAiClusterUnitShapeEnum

func GetMappingDedicatedAiClusterUnitShapeEnum ¶ 

func GetMappingDedicatedAiClusterUnitShapeEnum(val string) (DedicatedAiClusterUnitShapeEnum, bool)

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

type DeleteDedicatedAiClusterRequest ¶ 

type DeleteDedicatedAiClusterRequest struct {

	// The OCID (https://docs.cloud.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
}

DeleteDedicatedAiClusterRequest wrapper for the DeleteDedicatedAiCluster operation

See also ¶

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

func (DeleteDedicatedAiClusterRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteDedicatedAiClusterRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (DeleteDedicatedAiClusterRequest) RetryPolicy ¶ 

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

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

func (DeleteDedicatedAiClusterRequest) String ¶ 

func (request DeleteDedicatedAiClusterRequest) String() string

func (DeleteDedicatedAiClusterRequest) ValidateEnumValue ¶ 

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

type DeleteDedicatedAiClusterResponse ¶ 

type DeleteDedicatedAiClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteDedicatedAiClusterResponse wrapper for the DeleteDedicatedAiCluster operation

func (DeleteDedicatedAiClusterResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDedicatedAiClusterResponse) String ¶ 

func (response DeleteDedicatedAiClusterResponse) String() string

type DeleteEndpointRequest ¶ 

type DeleteEndpointRequest struct {

	// The OCID (https://docs.cloud.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
}

DeleteEndpointRequest wrapper for the DeleteEndpoint operation

See also ¶

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

func (DeleteEndpointRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteEndpointRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (DeleteEndpointRequest) RetryPolicy ¶ 

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

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

func (DeleteEndpointRequest) String ¶ 

func (request DeleteEndpointRequest) String() string

func (DeleteEndpointRequest) ValidateEnumValue ¶ 

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

type DeleteEndpointResponse ¶ 

type DeleteEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteEndpointResponse wrapper for the DeleteEndpoint operation

func (DeleteEndpointResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (DeleteEndpointResponse) String ¶ 

func (response DeleteEndpointResponse) String() string

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

DeleteModelRequest wrapper for the DeleteModel operation

See also ¶

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

func (DeleteModelRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteModelRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (DeleteModelRequest) RetryPolicy ¶ 

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

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

func (DeleteModelRequest) String ¶ 

func (request DeleteModelRequest) String() string

func (DeleteModelRequest) ValidateEnumValue ¶ 

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

type DeleteModelResponse ¶ 

type DeleteModelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteModelResponse wrapper for the DeleteModel operation

func (DeleteModelResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (DeleteModelResponse) String ¶ 

func (response DeleteModelResponse) String() string

type Endpoint ¶ 

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

	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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resouces (https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).

func (Endpoint) String ¶ 

func (m Endpoint) String() string

func (Endpoint) ValidateEnumValue ¶ 

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

type EndpointCollection ¶ 

type EndpointCollection struct {

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

EndpointCollection Results of an endpoint search. Contains EndpointSummary items and other information such as metadata.

func (EndpointCollection) String ¶ 

func (m EndpointCollection) String() string

func (EndpointCollection) ValidateEnumValue ¶ 

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

type EndpointLifecycleStateEnum ¶ 

type EndpointLifecycleStateEnum string

EndpointLifecycleStateEnum Enum with underlying type: string 

const (
	EndpointLifecycleStateActive   EndpointLifecycleStateEnum = "ACTIVE"
	EndpointLifecycleStateCreating EndpointLifecycleStateEnum = "CREATING"
	EndpointLifecycleStateUpdating EndpointLifecycleStateEnum = "UPDATING"
	EndpointLifecycleStateDeleting EndpointLifecycleStateEnum = "DELETING"
	EndpointLifecycleStateDeleted  EndpointLifecycleStateEnum = "DELETED"
	EndpointLifecycleStateFailed   EndpointLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for EndpointLifecycleStateEnum

func GetEndpointLifecycleStateEnumValues ¶ 

func GetEndpointLifecycleStateEnumValues() []EndpointLifecycleStateEnum

GetEndpointLifecycleStateEnumValues Enumerates the set of values for EndpointLifecycleStateEnum

func GetMappingEndpointLifecycleStateEnum ¶ 

func GetMappingEndpointLifecycleStateEnum(val string) (EndpointLifecycleStateEnum, bool)

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

type EndpointSummary ¶ 

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

EndpointSummary Summary information for an endpoint resource.

func (EndpointSummary) String ¶ 

func (m EndpointSummary) String() string

func (EndpointSummary) ValidateEnumValue ¶ 

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

type FineTuneDetails ¶ 

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

FineTuneDetails Details about fine-tuning a custom model.

func (FineTuneDetails) String ¶ 

func (m FineTuneDetails) String() string

func (*FineTuneDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

func (FineTuneDetails) ValidateEnumValue ¶ 

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

type GenerativeAiClient ¶ 

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

GenerativeAiClient a client for GenerativeAi

func NewGenerativeAiClientWithConfigurationProvider ¶ 

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 ¶ 

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 (GenerativeAiClient) ChangeDedicatedAiClusterCompartment ¶ 

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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also ¶

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

func (GenerativeAiClient) ChangeEndpointCompartment ¶ 

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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also ¶

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

func (GenerativeAiClient) ChangeModelCompartment ¶ 

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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also ¶

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

func (*GenerativeAiClient) ConfigurationProvider ¶ 

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

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

func (GenerativeAiClient) CreateDedicatedAiCluster ¶ 

func (client GenerativeAiClient) CreateDedicatedAiCluster(ctx context.Context, request CreateDedicatedAiClusterRequest) (response CreateDedicatedAiClusterResponse, err error)

CreateDedicatedAiCluster Creates a dedicated AI cluster.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) CreateEndpoint ¶ 

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.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) CreateModel ¶ 

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.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) DeleteDedicatedAiCluster ¶ 

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.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) DeleteEndpoint ¶ 

func (client GenerativeAiClient) DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) (response DeleteEndpointResponse, err error)

DeleteEndpoint Deletes an endpoint.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) DeleteModel ¶ 

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.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) GetDedicatedAiCluster ¶ 

func (client GenerativeAiClient) GetDedicatedAiCluster(ctx context.Context, request GetDedicatedAiClusterRequest) (response GetDedicatedAiClusterResponse, err error)

GetDedicatedAiCluster Gets information about a dedicated AI cluster.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) GetEndpoint ¶ 

func (client GenerativeAiClient) GetEndpoint(ctx context.Context, request GetEndpointRequest) (response GetEndpointResponse, err error)

GetEndpoint Gets information about an endpoint.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) GetModel ¶ 

func (client GenerativeAiClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)

GetModel Gets information about a custom model.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) GetWorkRequest ¶ 

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

GetWorkRequest Gets the details of a work request.

See also ¶

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

func (GenerativeAiClient) ListDedicatedAiClusters ¶ 

func (client GenerativeAiClient) ListDedicatedAiClusters(ctx context.Context, request ListDedicatedAiClustersRequest) (response ListDedicatedAiClustersResponse, err error)

ListDedicatedAiClusters Lists the dedicated AI clusters in a specific compartment.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) ListEndpoints ¶ 

func (client GenerativeAiClient) ListEndpoints(ctx context.Context, request ListEndpointsRequest) (response ListEndpointsResponse, err error)

ListEndpoints Lists the endpoints of a specific compartment.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) ListModels ¶ 

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.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) ListWorkRequestErrors ¶ 

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

ListWorkRequestErrors Lists the errors for a work request.

See also ¶

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

func (GenerativeAiClient) ListWorkRequestLogs ¶ 

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

ListWorkRequestLogs Lists the logs for a work request.

See also ¶

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

func (GenerativeAiClient) ListWorkRequests ¶ 

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

ListWorkRequests Lists the work requests in a compartment.

See also ¶

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

func (*GenerativeAiClient) SetRegion ¶ 

func (client *GenerativeAiClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (GenerativeAiClient) UpdateDedicatedAiCluster ¶ 

func (client GenerativeAiClient) UpdateDedicatedAiCluster(ctx context.Context, request UpdateDedicatedAiClusterRequest) (response UpdateDedicatedAiClusterResponse, err error)

UpdateDedicatedAiCluster Updates a dedicated AI cluster.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) UpdateEndpoint ¶ 

func (client GenerativeAiClient) UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (response UpdateEndpointResponse, err error)

UpdateEndpoint Updates the properties of an endpoint.

See also ¶

Click https://docs.cloud.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 (GenerativeAiClient) UpdateModel ¶ 

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.

See also ¶

Click https://docs.cloud.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()

type GetDedicatedAiClusterRequest ¶ 

type GetDedicatedAiClusterRequest struct {

	// The OCID (https://docs.cloud.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
}

GetDedicatedAiClusterRequest wrapper for the GetDedicatedAiCluster operation

See also ¶

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

func (GetDedicatedAiClusterRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (GetDedicatedAiClusterRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetDedicatedAiClusterRequest) RetryPolicy ¶ 

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

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

func (GetDedicatedAiClusterRequest) String ¶ 

func (request GetDedicatedAiClusterRequest) String() string

func (GetDedicatedAiClusterRequest) ValidateEnumValue ¶ 

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

type GetDedicatedAiClusterResponse ¶ 

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

GetDedicatedAiClusterResponse wrapper for the GetDedicatedAiCluster operation

func (GetDedicatedAiClusterResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetDedicatedAiClusterResponse) String ¶ 

func (response GetDedicatedAiClusterResponse) String() string

type GetEndpointRequest ¶ 

type GetEndpointRequest struct {

	// The OCID (https://docs.cloud.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
}

GetEndpointRequest wrapper for the GetEndpoint operation

See also ¶

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

func (GetEndpointRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (GetEndpointRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetEndpointRequest) RetryPolicy ¶ 

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

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

func (GetEndpointRequest) String ¶ 

func (request GetEndpointRequest) String() string

func (GetEndpointRequest) ValidateEnumValue ¶ 

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

type GetEndpointResponse ¶ 

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

GetEndpointResponse wrapper for the GetEndpoint operation

func (GetEndpointResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetEndpointResponse) String ¶ 

func (response GetEndpointResponse) String() string

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

GetModelRequest wrapper for the GetModel operation

See also ¶

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

func (GetModelRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (GetModelRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetModelRequest) RetryPolicy ¶ 

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

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

func (GetModelRequest) String ¶ 

func (request GetModelRequest) String() string

func (GetModelRequest) ValidateEnumValue ¶ 

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

type GetModelResponse ¶ 

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

GetModelResponse wrapper for the GetModel operation

func (GetModelResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetModelResponse) String ¶ 

func (response GetModelResponse) String() string

type GetWorkRequestRequest ¶ 

type GetWorkRequestRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also ¶

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

func (GetWorkRequestRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy ¶ 

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

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

func (GetWorkRequestRequest) String ¶ 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue ¶ 

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

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

type GetWorkRequestResponse ¶ 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String ¶ 

func (response GetWorkRequestResponse) String() string

type ListDedicatedAiClustersRequest ¶ 

type ListDedicatedAiClustersRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"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.cloud.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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either '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
}

ListDedicatedAiClustersRequest wrapper for the ListDedicatedAiClusters operation

See also ¶

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

func (ListDedicatedAiClustersRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ListDedicatedAiClustersRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListDedicatedAiClustersRequest) RetryPolicy ¶ 

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

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

func (ListDedicatedAiClustersRequest) String ¶ 

func (request ListDedicatedAiClustersRequest) String() string

func (ListDedicatedAiClustersRequest) ValidateEnumValue ¶ 

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

type ListDedicatedAiClustersResponse ¶ 

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDedicatedAiClustersResponse wrapper for the ListDedicatedAiClusters operation

func (ListDedicatedAiClustersResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListDedicatedAiClustersResponse) String ¶ 

func (response ListDedicatedAiClustersResponse) String() string

type ListDedicatedAiClustersSortByEnum ¶ 

type ListDedicatedAiClustersSortByEnum string

ListDedicatedAiClustersSortByEnum Enum with underlying type: string 

const (
	ListDedicatedAiClustersSortByTimecreated    ListDedicatedAiClustersSortByEnum = "timeCreated"
	ListDedicatedAiClustersSortByDisplayname    ListDedicatedAiClustersSortByEnum = "displayName"
	ListDedicatedAiClustersSortByLifecyclestate ListDedicatedAiClustersSortByEnum = "lifecycleState"
)

Set of constants representing the allowable values for ListDedicatedAiClustersSortByEnum

func GetListDedicatedAiClustersSortByEnumValues ¶ 

func GetListDedicatedAiClustersSortByEnumValues() []ListDedicatedAiClustersSortByEnum

GetListDedicatedAiClustersSortByEnumValues Enumerates the set of values for ListDedicatedAiClustersSortByEnum

func GetMappingListDedicatedAiClustersSortByEnum ¶ 

func GetMappingListDedicatedAiClustersSortByEnum(val string) (ListDedicatedAiClustersSortByEnum, bool)

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

type ListDedicatedAiClustersSortOrderEnum ¶ 

type ListDedicatedAiClustersSortOrderEnum string

ListDedicatedAiClustersSortOrderEnum Enum with underlying type: string 

const (
	ListDedicatedAiClustersSortOrderAsc  ListDedicatedAiClustersSortOrderEnum = "ASC"
	ListDedicatedAiClustersSortOrderDesc ListDedicatedAiClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDedicatedAiClustersSortOrderEnum

func GetListDedicatedAiClustersSortOrderEnumValues ¶ 

func GetListDedicatedAiClustersSortOrderEnumValues() []ListDedicatedAiClustersSortOrderEnum

GetListDedicatedAiClustersSortOrderEnumValues Enumerates the set of values for ListDedicatedAiClustersSortOrderEnum

func GetMappingListDedicatedAiClustersSortOrderEnum ¶ 

func GetMappingListDedicatedAiClustersSortOrderEnum(val string) (ListDedicatedAiClustersSortOrderEnum, bool)

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

type ListEndpointsRequest ¶ 

type ListEndpointsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
	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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either '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
}

ListEndpointsRequest wrapper for the ListEndpoints operation

See also ¶

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

func (ListEndpointsRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ListEndpointsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListEndpointsRequest) RetryPolicy ¶ 

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

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

func (ListEndpointsRequest) String ¶ 

func (request ListEndpointsRequest) String() string

func (ListEndpointsRequest) ValidateEnumValue ¶ 

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

type ListEndpointsResponse ¶ 

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListEndpointsResponse wrapper for the ListEndpoints operation

func (ListEndpointsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListEndpointsResponse) String ¶ 

func (response ListEndpointsResponse) String() string

type ListEndpointsSortByEnum ¶ 

type ListEndpointsSortByEnum string

ListEndpointsSortByEnum Enum with underlying type: string 

const (
	ListEndpointsSortByDisplayname ListEndpointsSortByEnum = "displayName"
	ListEndpointsSortByTimecreated ListEndpointsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListEndpointsSortByEnum

func GetListEndpointsSortByEnumValues ¶ 

func GetListEndpointsSortByEnumValues() []ListEndpointsSortByEnum

GetListEndpointsSortByEnumValues Enumerates the set of values for ListEndpointsSortByEnum

func GetMappingListEndpointsSortByEnum ¶ 

func GetMappingListEndpointsSortByEnum(val string) (ListEndpointsSortByEnum, bool)

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

type ListEndpointsSortOrderEnum ¶ 

type ListEndpointsSortOrderEnum string

ListEndpointsSortOrderEnum Enum with underlying type: string 

const (
	ListEndpointsSortOrderAsc  ListEndpointsSortOrderEnum = "ASC"
	ListEndpointsSortOrderDesc ListEndpointsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListEndpointsSortOrderEnum

func GetListEndpointsSortOrderEnumValues ¶ 

func GetListEndpointsSortOrderEnumValues() []ListEndpointsSortOrderEnum

GetListEndpointsSortOrderEnumValues Enumerates the set of values for ListEndpointsSortOrderEnum

func GetMappingListEndpointsSortOrderEnum ¶ 

func GetMappingListEndpointsSortOrderEnum(val string) (ListEndpointsSortOrderEnum, bool)

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

type ListModelsRequest ¶ 

type ListModelsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either '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
}

ListModelsRequest wrapper for the ListModels operation

See also ¶

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

func (ListModelsRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ListModelsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListModelsRequest) RetryPolicy ¶ 

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

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

func (ListModelsRequest) String ¶ 

func (request ListModelsRequest) String() string

func (ListModelsRequest) ValidateEnumValue ¶ 

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

type ListModelsResponse ¶ 

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListModelsResponse wrapper for the ListModels operation

func (ListModelsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListModelsResponse) String ¶ 

func (response ListModelsResponse) String() string

type ListModelsSortByEnum ¶ 

type ListModelsSortByEnum string

ListModelsSortByEnum Enum with underlying type: string 

const (
	ListModelsSortByDisplayname    ListModelsSortByEnum = "displayName"
	ListModelsSortByLifecyclestate ListModelsSortByEnum = "lifecycleState"
	ListModelsSortByTimecreated    ListModelsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListModelsSortByEnum

func GetListModelsSortByEnumValues ¶ 

func GetListModelsSortByEnumValues() []ListModelsSortByEnum

GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum

func GetMappingListModelsSortByEnum ¶ 

func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)

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

type ListModelsSortOrderEnum ¶ 

type ListModelsSortOrderEnum string

ListModelsSortOrderEnum Enum with underlying type: string 

const (
	ListModelsSortOrderAsc  ListModelsSortOrderEnum = "ASC"
	ListModelsSortOrderDesc ListModelsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListModelsSortOrderEnum

func GetListModelsSortOrderEnumValues ¶ 

func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum

GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum

func GetMappingListModelsSortOrderEnum ¶ 

func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest ¶ 

type ListWorkRequestErrorsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
	SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either '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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also ¶

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy ¶ 

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

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

func (ListWorkRequestErrorsRequest) String ¶ 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue ¶ 

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestErrorsResponse ¶ 

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestErrorCollection instances
	WorkRequestErrorCollection `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String ¶ 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum ¶ 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues ¶ 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum ¶ 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum ¶ 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues ¶ 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum ¶ 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest ¶ 

type ListWorkRequestLogsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
	SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either '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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also ¶

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

func (ListWorkRequestLogsRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy ¶ 

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

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

func (ListWorkRequestLogsRequest) String ¶ 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue ¶ 

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestLogsResponse ¶ 

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestLogEntryCollection instances
	WorkRequestLogEntryCollection `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String ¶ 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum ¶ 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues ¶ 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum ¶ 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum ¶ 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues ¶ 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum ¶ 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest ¶ 

type ListWorkRequestsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

	// A filter to return only the resources that match the given lifecycle state.
	Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The sort order to use, either '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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also ¶

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

func (ListWorkRequestsRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy ¶ 

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

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

func (ListWorkRequestsRequest) String ¶ 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue ¶ 

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

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

type ListWorkRequestsResponse ¶ 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String ¶ 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum ¶ 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues ¶ 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum ¶ 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum ¶ 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues ¶ 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum ¶ 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type ListWorkRequestsStatusEnum ¶ 

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string 

const (
	ListWorkRequestsStatusAccepted   ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting    ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusFailed     ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded  ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling  ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled   ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues ¶ 

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum ¶ 

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

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

type LoraTrainingConfig ¶ added in v65.67.0 

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

LoraTrainingConfig The Lora training method hyperparameters.

func (LoraTrainingConfig) GetEarlyStoppingPatience ¶ added in v65.67.0 

func (m LoraTrainingConfig) GetEarlyStoppingPatience() *int

GetEarlyStoppingPatience returns EarlyStoppingPatience

func (LoraTrainingConfig) GetEarlyStoppingThreshold ¶ added in v65.67.0 

func (m LoraTrainingConfig) GetEarlyStoppingThreshold() *float64

GetEarlyStoppingThreshold returns EarlyStoppingThreshold

func (LoraTrainingConfig) GetLearningRate ¶ added in v65.67.0 

func (m LoraTrainingConfig) GetLearningRate() *float64

GetLearningRate returns LearningRate

func (LoraTrainingConfig) GetLogModelMetricsIntervalInSteps ¶ added in v65.67.0 

func (m LoraTrainingConfig) GetLogModelMetricsIntervalInSteps() *int

GetLogModelMetricsIntervalInSteps returns LogModelMetricsIntervalInSteps

func (LoraTrainingConfig) GetTotalTrainingEpochs ¶ added in v65.67.0 

func (m LoraTrainingConfig) GetTotalTrainingEpochs() *int

GetTotalTrainingEpochs returns TotalTrainingEpochs

func (LoraTrainingConfig) GetTrainingBatchSize ¶ added in v65.67.0 

func (m LoraTrainingConfig) GetTrainingBatchSize() *int

GetTrainingBatchSize returns TrainingBatchSize

func (LoraTrainingConfig) MarshalJSON ¶ added in v65.67.0 

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

MarshalJSON marshals to json representation

func (LoraTrainingConfig) String ¶ added in v65.67.0 

func (m LoraTrainingConfig) String() string

func (LoraTrainingConfig) ValidateEnumValue ¶ added in v65.67.0 

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

type Model ¶ 

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

	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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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.cloud.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.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resouces (https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).

func (Model) String ¶ 

func (m Model) String() string

func (*Model) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

func (Model) ValidateEnumValue ¶ 

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

type ModelCapabilityEnum ¶ 

type ModelCapabilityEnum string

ModelCapabilityEnum Enum with underlying type: string 

const (
	ModelCapabilityTextGeneration    ModelCapabilityEnum = "TEXT_GENERATION"
	ModelCapabilityTextSummarization ModelCapabilityEnum = "TEXT_SUMMARIZATION"
	ModelCapabilityTextEmbeddings    ModelCapabilityEnum = "TEXT_EMBEDDINGS"
	ModelCapabilityFineTune          ModelCapabilityEnum = "FINE_TUNE"
	ModelCapabilityChat              ModelCapabilityEnum = "CHAT"
)

Set of constants representing the allowable values for ModelCapabilityEnum

func GetMappingModelCapabilityEnum ¶ 

func GetMappingModelCapabilityEnum(val string) (ModelCapabilityEnum, bool)

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

func GetModelCapabilityEnumValues ¶ 

func GetModelCapabilityEnumValues() []ModelCapabilityEnum

GetModelCapabilityEnumValues Enumerates the set of values for ModelCapabilityEnum

type ModelCollection ¶ 

type ModelCollection struct {

	// The results of a model search.
	Items []ModelSummary `mandatory:"true" json:"items"`
}

ModelCollection Results of a model search. Contains ModelSummary items and other information such as metadata.

func (ModelCollection) String ¶ 

func (m ModelCollection) String() string

func (ModelCollection) ValidateEnumValue ¶ 

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

type ModelLifecycleStateEnum ¶ 

type ModelLifecycleStateEnum string

ModelLifecycleStateEnum Enum with underlying type: string 

const (
	ModelLifecycleStateActive   ModelLifecycleStateEnum = "ACTIVE"
	ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
	ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
	ModelLifecycleStateDeleted  ModelLifecycleStateEnum = "DELETED"
	ModelLifecycleStateFailed   ModelLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ModelLifecycleStateEnum

func GetMappingModelLifecycleStateEnum ¶ 

func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)

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

func GetModelLifecycleStateEnumValues ¶ 

func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum

GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum

type ModelMetrics ¶ 

type ModelMetrics interface {
}

ModelMetrics Model metrics during the creation of a new model.

type ModelMetricsModelMetricsTypeEnum ¶ 

type ModelMetricsModelMetricsTypeEnum string

ModelMetricsModelMetricsTypeEnum Enum with underlying type: string 

const (
	ModelMetricsModelMetricsTypeTextGenerationModelMetrics ModelMetricsModelMetricsTypeEnum = "TEXT_GENERATION_MODEL_METRICS"
	ModelMetricsModelMetricsTypeChatModelMetrics           ModelMetricsModelMetricsTypeEnum = "CHAT_MODEL_METRICS"
)

Set of constants representing the allowable values for ModelMetricsModelMetricsTypeEnum

func GetMappingModelMetricsModelMetricsTypeEnum ¶ 

func GetMappingModelMetricsModelMetricsTypeEnum(val string) (ModelMetricsModelMetricsTypeEnum, bool)

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

func GetModelMetricsModelMetricsTypeEnumValues ¶ 

func GetModelMetricsModelMetricsTypeEnumValues() []ModelMetricsModelMetricsTypeEnum

GetModelMetricsModelMetricsTypeEnumValues Enumerates the set of values for ModelMetricsModelMetricsTypeEnum

type ModelSummary ¶ 

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

ModelSummary Summary of the model.

func (ModelSummary) String ¶ 

func (m ModelSummary) String() string

func (*ModelSummary) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

func (ModelSummary) ValidateEnumValue ¶ 

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

type ModelTypeEnum ¶ 

type ModelTypeEnum string

ModelTypeEnum Enum with underlying type: string 

const (
	ModelTypeBase   ModelTypeEnum = "BASE"
	ModelTypeCustom ModelTypeEnum = "CUSTOM"
)

Set of constants representing the allowable values for ModelTypeEnum

func GetMappingModelTypeEnum ¶ 

func GetMappingModelTypeEnum(val string) (ModelTypeEnum, bool)

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

func GetModelTypeEnumValues ¶ 

func GetModelTypeEnumValues() []ModelTypeEnum

GetModelTypeEnumValues Enumerates the set of values for ModelTypeEnum

type ObjectStorageDataset ¶ 

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

ObjectStorageDataset The dataset is stored in an OCI Object Storage bucket.

func (ObjectStorageDataset) MarshalJSON ¶ 

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

MarshalJSON marshals to json representation

func (ObjectStorageDataset) String ¶ 

func (m ObjectStorageDataset) String() string

func (ObjectStorageDataset) ValidateEnumValue ¶ 

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

type OperationStatusEnum ¶ 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting    OperationStatusEnum = "WAITING"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum ¶ 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues ¶ 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum ¶ 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum ¶ 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues ¶ 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type SortOrderEnum ¶ 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum ¶ 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues ¶ 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type TFewTrainingConfig ¶ 

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

TFewTrainingConfig The TFEW training method hyperparameters.

func (TFewTrainingConfig) GetEarlyStoppingPatience ¶ 

func (m TFewTrainingConfig) GetEarlyStoppingPatience() *int

GetEarlyStoppingPatience returns EarlyStoppingPatience

func (TFewTrainingConfig) GetEarlyStoppingThreshold ¶ 

func (m TFewTrainingConfig) GetEarlyStoppingThreshold() *float64

GetEarlyStoppingThreshold returns EarlyStoppingThreshold

func (TFewTrainingConfig) GetLearningRate ¶ 

func (m TFewTrainingConfig) GetLearningRate() *float64

GetLearningRate returns LearningRate

func (TFewTrainingConfig) GetLogModelMetricsIntervalInSteps ¶ 

func (m TFewTrainingConfig) GetLogModelMetricsIntervalInSteps() *int

GetLogModelMetricsIntervalInSteps returns LogModelMetricsIntervalInSteps

func (TFewTrainingConfig) GetTotalTrainingEpochs ¶ 

func (m TFewTrainingConfig) GetTotalTrainingEpochs() *int

GetTotalTrainingEpochs returns TotalTrainingEpochs

func (TFewTrainingConfig) GetTrainingBatchSize ¶ 

func (m TFewTrainingConfig) GetTrainingBatchSize() *int

GetTrainingBatchSize returns TrainingBatchSize

func (TFewTrainingConfig) MarshalJSON ¶ 

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

MarshalJSON marshals to json representation

func (TFewTrainingConfig) String ¶ 

func (m TFewTrainingConfig) String() string

func (TFewTrainingConfig) ValidateEnumValue ¶ 

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

type TextGenerationModelMetrics ¶ 

type TextGenerationModelMetrics struct {

	// Fine-tuned model accuracy.
	FinalAccuracy *float64 `mandatory:"false" json:"finalAccuracy"`

	// Fine-tuned model loss.
	FinalLoss *float64 `mandatory:"false" json:"finalLoss"`
}

TextGenerationModelMetrics The text generation model metrics of the fine-tuning process.

func (TextGenerationModelMetrics) MarshalJSON ¶ 

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

MarshalJSON marshals to json representation

func (TextGenerationModelMetrics) String ¶ 

func (m TextGenerationModelMetrics) String() string

func (TextGenerationModelMetrics) ValidateEnumValue ¶ 

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

type TrainingConfig ¶ 

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
}

TrainingConfig The fine-tuning method and hyperparameters used for fine-tuning a custom model.

type TrainingConfigTrainingConfigTypeEnum ¶ 

type TrainingConfigTrainingConfigTypeEnum string

TrainingConfigTrainingConfigTypeEnum Enum with underlying type: string 

const (
	TrainingConfigTrainingConfigTypeTfewTrainingConfig    TrainingConfigTrainingConfigTypeEnum = "TFEW_TRAINING_CONFIG"
	TrainingConfigTrainingConfigTypeVanillaTrainingConfig TrainingConfigTrainingConfigTypeEnum = "VANILLA_TRAINING_CONFIG"
	TrainingConfigTrainingConfigTypeLoraTrainingConfig    TrainingConfigTrainingConfigTypeEnum = "LORA_TRAINING_CONFIG"
)

Set of constants representing the allowable values for TrainingConfigTrainingConfigTypeEnum

func GetMappingTrainingConfigTrainingConfigTypeEnum ¶ 

func GetMappingTrainingConfigTrainingConfigTypeEnum(val string) (TrainingConfigTrainingConfigTypeEnum, bool)

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

func GetTrainingConfigTrainingConfigTypeEnumValues ¶ 

func GetTrainingConfigTrainingConfigTypeEnumValues() []TrainingConfigTrainingConfigTypeEnum

GetTrainingConfigTrainingConfigTypeEnumValues Enumerates the set of values for TrainingConfigTrainingConfigTypeEnum

type UpdateDedicatedAiClusterDetails ¶ 

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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDedicatedAiClusterDetails The data to update a dedicated AI cluster.

func (UpdateDedicatedAiClusterDetails) String ¶ 

func (m UpdateDedicatedAiClusterDetails) String() string

func (UpdateDedicatedAiClusterDetails) ValidateEnumValue ¶ 

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

type UpdateDedicatedAiClusterRequest ¶ 

type UpdateDedicatedAiClusterRequest struct {

	// The OCID (https://docs.cloud.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
}

UpdateDedicatedAiClusterRequest wrapper for the UpdateDedicatedAiCluster operation

See also ¶

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

func (UpdateDedicatedAiClusterRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateDedicatedAiClusterRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (UpdateDedicatedAiClusterRequest) RetryPolicy ¶ 

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

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

func (UpdateDedicatedAiClusterRequest) String ¶ 

func (request UpdateDedicatedAiClusterRequest) String() string

func (UpdateDedicatedAiClusterRequest) ValidateEnumValue ¶ 

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

type UpdateDedicatedAiClusterResponse ¶ 

type UpdateDedicatedAiClusterResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DedicatedAiCluster instance
	DedicatedAiCluster `presentIn:"body"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateDedicatedAiClusterResponse wrapper for the UpdateDedicatedAiCluster operation

func (UpdateDedicatedAiClusterResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDedicatedAiClusterResponse) String ¶ 

func (response UpdateDedicatedAiClusterResponse) String() string

type UpdateEndpointDetails ¶ 

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

	ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateEndpointDetails The data to update an endpoint.

func (UpdateEndpointDetails) String ¶ 

func (m UpdateEndpointDetails) String() string

func (UpdateEndpointDetails) ValidateEnumValue ¶ 

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

type UpdateEndpointRequest ¶ 

type UpdateEndpointRequest struct {

	// The OCID (https://docs.cloud.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
}

UpdateEndpointRequest wrapper for the UpdateEndpoint operation

See also ¶

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

func (UpdateEndpointRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateEndpointRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (UpdateEndpointRequest) RetryPolicy ¶ 

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

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

func (UpdateEndpointRequest) String ¶ 

func (request UpdateEndpointRequest) String() string

func (UpdateEndpointRequest) ValidateEnumValue ¶ 

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

type UpdateEndpointResponse ¶ 

type UpdateEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Endpoint instance
	Endpoint `presentIn:"body"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateEndpointResponse wrapper for the UpdateEndpoint operation

func (UpdateEndpointResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (UpdateEndpointResponse) String ¶ 

func (response UpdateEndpointResponse) String() string

type UpdateModelDetails ¶ 

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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateModelDetails The data to update a custom model.

func (UpdateModelDetails) String ¶ 

func (m UpdateModelDetails) String() string

func (UpdateModelDetails) ValidateEnumValue ¶ 

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

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

UpdateModelRequest wrapper for the UpdateModel operation

See also ¶

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

func (UpdateModelRequest) BinaryRequestBody ¶ 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateModelRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (UpdateModelRequest) RetryPolicy ¶ 

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

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

func (UpdateModelRequest) String ¶ 

func (request UpdateModelRequest) String() string

func (UpdateModelRequest) ValidateEnumValue ¶ 

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

type UpdateModelResponse ¶ 

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

UpdateModelResponse wrapper for the UpdateModel operation

func (UpdateModelResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (UpdateModelResponse) String ¶ 

func (response UpdateModelResponse) String() string

type VanillaTrainingConfig ¶ 

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

VanillaTrainingConfig The Vanilla training method hyperparameters.

func (VanillaTrainingConfig) GetEarlyStoppingPatience ¶ 

func (m VanillaTrainingConfig) GetEarlyStoppingPatience() *int

GetEarlyStoppingPatience returns EarlyStoppingPatience

func (VanillaTrainingConfig) GetEarlyStoppingThreshold ¶ 

func (m VanillaTrainingConfig) GetEarlyStoppingThreshold() *float64

GetEarlyStoppingThreshold returns EarlyStoppingThreshold

func (VanillaTrainingConfig) GetLearningRate ¶ 

func (m VanillaTrainingConfig) GetLearningRate() *float64

GetLearningRate returns LearningRate

func (VanillaTrainingConfig) GetLogModelMetricsIntervalInSteps ¶ 

func (m VanillaTrainingConfig) GetLogModelMetricsIntervalInSteps() *int

GetLogModelMetricsIntervalInSteps returns LogModelMetricsIntervalInSteps

func (VanillaTrainingConfig) GetTotalTrainingEpochs ¶ 

func (m VanillaTrainingConfig) GetTotalTrainingEpochs() *int

GetTotalTrainingEpochs returns TotalTrainingEpochs

func (VanillaTrainingConfig) GetTrainingBatchSize ¶ 

func (m VanillaTrainingConfig) GetTrainingBatchSize() *int

GetTrainingBatchSize returns TrainingBatchSize

func (VanillaTrainingConfig) MarshalJSON ¶ 

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

MarshalJSON marshals to json representation

func (VanillaTrainingConfig) String ¶ 

func (m VanillaTrainingConfig) String() string

func (VanillaTrainingConfig) ValidateEnumValue ¶ 

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

type WorkRequest ¶ 

type WorkRequest struct {

	// The asynchronous operation tracked by this work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources that are affected by the work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Shows the progress of the operation tracked by the work request, as a percentage of the total work
	// that must be performed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request was started, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request was finished, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

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.

func (WorkRequest) String ¶ 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue ¶ 

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

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

type WorkRequestError ¶ 

type WorkRequestError struct {

	// A machine-usable code for the error that occurred. For a list of error codes, see
	// API Errors (https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error message.
	Message *string `mandatory:"true" json:"message"`

	// The date and time that the error occurred, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestError) String ¶ 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue ¶ 

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

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

type WorkRequestErrorCollection ¶ 

type WorkRequestErrorCollection struct {

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

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

func (WorkRequestErrorCollection) String ¶ 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue ¶ 

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

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

type WorkRequestLogEntry ¶ 

type WorkRequestLogEntry struct {

	// A human-readable log message.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the log message was written, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestLogEntry The log message from performing an operation that is tracked by this work request.

func (WorkRequestLogEntry) String ¶ 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue ¶ 

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

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

type WorkRequestLogEntryCollection ¶ 

type WorkRequestLogEntryCollection struct {

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

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

func (WorkRequestLogEntryCollection) String ¶ 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue ¶ 

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

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

type WorkRequestResource ¶ 

type WorkRequestResource struct {

	// The resource type that the work request affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource is affected by the operation tracked in the work request.
	// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
	// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
	// or DELETED, respectively.
	ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

	// An OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path that you can use for a GET request to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`

	// Additional information that helps to explain the resource.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

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

func (WorkRequestResource) String ¶ 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue ¶ 

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

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

type WorkRequestResourceMetadataKeyEnum ¶ 

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string 

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum ¶ 

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues ¶ 

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary ¶ 

type WorkRequestSummary struct {

	// The asynchronous operation tracked by this work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources that are affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Shows the progress of the operation tracked by the work request, as a percentage of the total work
	// that must be performed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request was started, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request was finished, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String ¶ 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue ¶ 

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

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

type WorkRequestSummaryCollection ¶ 

type WorkRequestSummaryCollection struct {

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

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

func (WorkRequestSummaryCollection) String ¶ 

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue ¶ 

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

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

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

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