generativeai.oracle.com/v1beta1 &para;

DedicatedAiClusterCapacity defines nested fields for DedicatedAiCluster.Capacity.

Field	Description	Type	Required	Default	Enum
`capacityType`	-	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`totalEndpointCapacity`	The total number of endpoints that can be hosted on this dedicated AI cluster.	`integer`	No	-	-
`usedEndpointCapacity`	The number of endpoints hosted on this dedicated AI cluster.	`integer`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Endpoint¶

Endpoint is the Schema for the endpoints API.

Plural: endpoints
Scope: Namespaced
APIVersion: generativeai.oracle.com/v1beta1
Sample: Sample (config/samples/generativeai_v1beta1_endpoint.yaml)
Packages: Generative AI (v2.1.0-alpha)

Spec¶

EndpointSpec defines the desired state of Endpoint.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The compartment OCID to create the endpoint in.	`string`	Yes	-	-
`contentModerationConfig`	EndpointContentModerationConfig defines nested fields for Endpoint.ContentModerationConfig.	`object`	No	-	-
`dedicatedAiClusterId`	The OCID of the dedicated AI cluster on which a model will be deployed to.	`string`	Yes	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`	`map[string, map[string, string]]`	No	-	-
`description`	An optional description of the endpoint.	`string`	No	-	-
`displayName`	A user-friendly name. Does not have to be unique, and it's changeable.	`string`	No	-	-
`freeformTags`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`	`map[string, string]`	No	-	-
`generativeAiPrivateEndpointId`	The OCID of the Generative AI private endpoint to which this endpoint is attached to.	`string`	No	-	-
`modelId`	The OCID of the model that's used to create this endpoint.	`string`	Yes	-	-
`piiDetectionConfig`	EndpointPiiDetectionConfig defines nested fields for Endpoint.PiiDetectionConfig.	`object`	No	-	-
`promptInjectionConfig`	EndpointPromptInjectionConfig defines nested fields for Endpoint.PromptInjectionConfig.	`object`	No	-	-

Spec.contentModerationConfig¶

Back to Endpoint spec

EndpointContentModerationConfig defines nested fields for Endpoint.ContentModerationConfig.

Field	Description	Type	Required	Default	Enum
`isEnabled`	Whether to enable the content moderation feature.	`boolean`	Yes	-	-
`mode`	Enum for the modes of operation for inference protection.	`string`	No	-	-
`modelId`	The OCID of the model used for the feature.	`string`	No	-	-

Spec.piiDetectionConfig¶

Back to Endpoint spec

EndpointPiiDetectionConfig defines nested fields for Endpoint.PiiDetectionConfig.

Field	Description	Type	Required	Default	Enum
`isEnabled`	Whether to enable the PII detection feature.	`boolean`	Yes	-	-
`mode`	The mode of operation for PII detection.	`string`	No	-	-
`modelId`	The OCID of the model used for the feature.	`string`	No	-	-

Spec.promptInjectionConfig¶

Back to Endpoint spec

EndpointPromptInjectionConfig defines nested fields for Endpoint.PromptInjectionConfig.

Field	Description	Type	Required	Default	Enum
`isEnabled`	Whether to enable the prompt injection feature.	`boolean`	Yes	-	-
`mode`	The mode of operation for prompt injection detection.	`string`	No	-	-
`modelId`	The OCID of the model used for the feature.	`string`	No	-	-

Status¶

EndpointStatus defines the observed state of Endpoint.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The compartment OCID to create the endpoint in.	`string`	No	-	-
`contentModerationConfig`	EndpointContentModerationConfig defines nested fields for Endpoint.ContentModerationConfig.	`object`	No	-	-
`dedicatedAiClusterId`	The OCID of the dedicated AI cluster on which the model will be deployed to.	`string`	No	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`	`map[string, map[string, string]]`	No	-	-
`description`	An optional description of the endpoint.	`string`	No	-	-
`displayName`	A user-friendly name. Does not have to be unique, and it's changeable.	`string`	No	-	-
`freeformTags`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`	`map[string, string]`	No	-	-
`generativeAiPrivateEndpointId`	The OCID of the Generative AI private endpoint to which this endpoint is attached to.	`string`	No	-	-
`id`	An OCID that uniquely identifies this endpoint resource.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state of the endpoint in more detail that can provide actionable information.	`string`	No	-	-
`lifecycleState`	The current state of the endpoint.	`string`	No	-	-
`modelId`	The OCID of the model that's used to create this endpoint.	`string`	No	-	-
`piiDetectionConfig`	EndpointPiiDetectionConfig defines nested fields for Endpoint.PiiDetectionConfig.	`object`	No	-	-
`promptInjectionConfig`	EndpointPromptInjectionConfig defines nested fields for Endpoint.PromptInjectionConfig.	`object`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The date and time that the endpoint was created in the format of an RFC3339 datetime string.	`string`	No	-	-
`timeUpdated`	The date and time that the endpoint was updated in the format of an RFC3339 datetime string.	`string`	No	-	-

Status.contentModerationConfig¶

EndpointContentModerationConfig defines nested fields for Endpoint.ContentModerationConfig.

Field	Description	Type	Required	Default	Enum
`isEnabled`	Whether to enable the content moderation feature.	`boolean`	Yes	-	-
`mode`	Enum for the modes of operation for inference protection.	`string`	No	-	-
`modelId`	The OCID of the model used for the feature.	`string`	No	-	-

Status.piiDetectionConfig¶

EndpointPiiDetectionConfig defines nested fields for Endpoint.PiiDetectionConfig.

Field	Description	Type	Required	Default	Enum
`isEnabled`	Whether to enable the PII detection feature.	`boolean`	Yes	-	-
`mode`	The mode of operation for PII detection.	`string`	No	-	-
`modelId`	The OCID of the model used for the feature.	`string`	No	-	-

Status.promptInjectionConfig¶

EndpointPromptInjectionConfig defines nested fields for Endpoint.PromptInjectionConfig.

Field	Description	Type	Required	Default	Enum
`isEnabled`	Whether to enable the prompt injection feature.	`boolean`	Yes	-	-
`mode`	The mode of operation for prompt injection detection.	`string`	No	-	-
`modelId`	The OCID of the model used for the feature.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Model¶

Model is the Schema for the models API.

Plural: models
Scope: Namespaced
APIVersion: generativeai.oracle.com/v1beta1
Sample: Sample (config/samples/generativeai_v1beta1_model.yaml)
Packages: Generative AI (v2.1.0-alpha)

Spec¶

ModelSpec defines the desired state of Model.

Field	Description	Type	Required	Default	Enum
`baseModelId`	The OCID of the base model that's used for fine-tuning.	`string`	Yes	-	-
`compartmentId`	The compartment OCID for fine-tuned models. For pretrained models, this value is null.	`string`	Yes	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`	`map[string, map[string, string]]`	No	-	-
`description`	An optional description of the model.	`string`	No	-	-
`displayName`	A user-friendly name.	`string`	No	-	-
`fineTuneDetails`	ModelFineTuneDetails defines nested fields for Model.FineTuneDetails.	`object`	Yes	-	-
`freeformTags`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`	`map[string, string]`	No	-	-
`vendor`	The provider of the model.	`string`	No	-	-
`version`	The version of the model.	`string`	No	-	-

Spec.fineTuneDetails¶

Back to Model spec

ModelFineTuneDetails defines nested fields for Model.FineTuneDetails.

Field	Description	Type	Required	Default	Enum
`dedicatedAiClusterId`	The OCID of the dedicated AI cluster this fine-tuning runs on.	`string`	Yes	-	-
`trainingConfig`	ModelFineTuneDetailsTrainingConfig defines nested fields for Model.FineTuneDetails.TrainingConfig.	`object`	No	-	-
`trainingDataset`	ModelFineTuneDetailsTrainingDataset defines nested fields for Model.FineTuneDetails.TrainingDataset.	`object`	Yes	-	-

Spec.fineTuneDetails.trainingConfig¶

Back to Model spec

ModelFineTuneDetailsTrainingConfig defines nested fields for Model.FineTuneDetails.TrainingConfig.

Field	Description	Type	Required	Default	Enum
`earlyStoppingPatience`	Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.	`integer`	No	-	-
`earlyStoppingThreshold`	How much the loss must improve to prevent early stopping.	`number`	No	-	-
`jsonData`	-	`string`	No	-	-
`learningRate`	The initial learning rate to be used during training	`number`	No	-	-
`logModelMetricsIntervalInSteps`	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.	`integer`	No	-	-
`loraAlpha`	This parameter represents the scaling factor for the weight matrices in LoRA.	`integer`	No	-	-
`loraDropout`	This parameter indicates the dropout probability for LoRA layers.	`number`	No	-	-
`loraR`	This parameter represents the LoRA rank of the update matrices.	`integer`	No	-	-
`numOfLastLayers`	The number of last layers to be fine-tuned.	`integer`	No	-	-
`totalTrainingEpochs`	The maximum number of training epochs to run for.	`integer`	No	-	-
`trainingBatchSize`	The batch size used during training.	`integer`	No	-	-
`trainingConfigType`	-	`string`	No	-	-

Spec.fineTuneDetails.trainingDataset¶

Back to Model spec

ModelFineTuneDetailsTrainingDataset defines nested fields for Model.FineTuneDetails.TrainingDataset.

Field	Description	Type	Required	Default	Enum
`bucketName`	The Object Storage bucket name.	`string`	No	-	-
`datasetType`	-	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`namespaceName`	The Object Storage namespace.	`string`	No	-	-
`objectName`	The Object Storage object name.	`string`	No	-	-

Status¶

ModelStatus defines the observed state of Model.

Field	Description	Type	Required	Default	Enum
`baseModelId`	The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null.	`string`	No	-	-
`capabilities`	Describes what this model can be used for.	`list[string]`	No	-	-
`compartmentId`	The compartment OCID for fine-tuned models. For pretrained models, this value is null.	`string`	No	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`	`map[string, map[string, string]]`	No	-	-
`description`	An optional description of the model.	`string`	No	-	-
`displayName`	A user-friendly name.	`string`	No	-	-
`fineTuneDetails`	ModelFineTuneDetails defines nested fields for Model.FineTuneDetails.	`object`	No	-	-
`freeformTags`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`	`map[string, string]`	No	-	-
`id`	An ID that uniquely identifies a pretrained or fine-tuned model.	`string`	No	-	-
`isLongTermSupported`	Whether a model is supported long-term. Only applicable to base models.	`boolean`	No	-	-
`lifecycleDetails`	A message describing the current state of the model in more detail that can provide actionable information.	`string`	No	-	-
`lifecycleState`	The lifecycle state of the model.	`string`	No	-	-
`modelMetrics`	ModelMetrics defines nested fields for Model.ModelMetrics.	`object`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The date and time that the model was created in the format of an RFC3339 datetime string.	`string`	No	-	-
`timeDedicatedRetired`	The timestamp indicating when the custom model and its associated foundation model will be fully retired.	`string`	No	-	-
`timeDeprecated`	Corresponds to the time when the custom model and its associated foundation model will be deprecated.	`string`	No	-	-
`timeOnDemandRetired`	The timestamp indicating when the base model will no longer be available for on-demand usage.	`string`	No	-	-
`timeUpdated`	The date and time that the model was updated in the format of an RFC3339 datetime string.	`string`	No	-	-
`type`	The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.	`string`	No	-	-
`vendor`	The provider of the base model.	`string`	No	-	-
`version`	The version of the model.	`string`	No	-	-

Status.fineTuneDetails¶

ModelFineTuneDetails defines nested fields for Model.FineTuneDetails.

Field	Description	Type	Required	Default	Enum
`dedicatedAiClusterId`	The OCID of the dedicated AI cluster this fine-tuning runs on.	`string`	Yes	-	-
`trainingConfig`	ModelFineTuneDetailsTrainingConfig defines nested fields for Model.FineTuneDetails.TrainingConfig.	`object`	No	-	-
`trainingDataset`	ModelFineTuneDetailsTrainingDataset defines nested fields for Model.FineTuneDetails.TrainingDataset.	`object`	Yes	-	-

Status.fineTuneDetails.trainingConfig¶

ModelFineTuneDetailsTrainingConfig defines nested fields for Model.FineTuneDetails.TrainingConfig.

Field	Description	Type	Required	Default	Enum
`earlyStoppingPatience`	Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.	`integer`	No	-	-
`earlyStoppingThreshold`	How much the loss must improve to prevent early stopping.	`number`	No	-	-
`jsonData`	-	`string`	No	-	-
`learningRate`	The initial learning rate to be used during training	`number`	No	-	-
`logModelMetricsIntervalInSteps`	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.	`integer`	No	-	-
`loraAlpha`	This parameter represents the scaling factor for the weight matrices in LoRA.	`integer`	No	-	-
`loraDropout`	This parameter indicates the dropout probability for LoRA layers.	`number`	No	-	-
`loraR`	This parameter represents the LoRA rank of the update matrices.	`integer`	No	-	-
`numOfLastLayers`	The number of last layers to be fine-tuned.	`integer`	No	-	-
`totalTrainingEpochs`	The maximum number of training epochs to run for.	`integer`	No	-	-
`trainingBatchSize`	The batch size used during training.	`integer`	No	-	-
`trainingConfigType`	-	`string`	No	-	-

Status.fineTuneDetails.trainingDataset¶

ModelFineTuneDetailsTrainingDataset defines nested fields for Model.FineTuneDetails.TrainingDataset.

Field	Description	Type	Required	Default	Enum
`bucketName`	The Object Storage bucket name.	`string`	No	-	-
`datasetType`	-	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`namespaceName`	The Object Storage namespace.	`string`	No	-	-
`objectName`	The Object Storage object name.	`string`	No	-	-

Status.modelMetrics¶

ModelMetrics defines nested fields for Model.ModelMetrics.

Field	Description	Type	Required	Default	Enum
`finalAccuracy`	Fine-tuned model accuracy.	`number`	No	-	-
`finalLoss`	Fine-tuned model loss.	`number`	No	-	-
`jsonData`	-	`string`	No	-	-
`modelMetricsType`	-	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶