Generative AI: Model¶
Manage OCI Generative AI resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | generativeai |
| Resource | Model |
| API Version | generativeai.oracle.com/v1beta1 |
| Package | Generative AI |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-generativeai-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/generativeai_v1beta1_model.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/generativeai_v1beta1_model.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
#
# Replace the compartment, base model, and DedicatedAiCluster OCIDs before running e2e.
# Keeping spec.displayName empty disables pre-create reuse; setting it allows the
# controller to bind an existing custom Model only when the returned OCI list item
# matches spec.compartmentId, spec.baseModelId, spec.fineTuneDetails.dedicatedAiClusterId,
# and any populated spec.displayName.
#
apiVersion: generativeai.oracle.com/v1beta1
kind: Model
metadata:
name: model-sample
spec:
compartmentId: ocid1.compartment.oc1..exampleuniqueID
baseModelId: ocid1.generativeaimodel.oc1..exampleuniqueID
displayName: osok-model-sample
description: OSOK Model sample
fineTuneDetails:
dedicatedAiClusterId: ocid1.generativeaidedicatedaicluster.oc1..exampleuniqueID
trainingDataset:
datasetType: OBJECT_STORAGE
namespaceName: object-storage-namespace
bucketName: generativeai-training-data
objectName: datasets/model-training.jsonl
freeformTags:
managed-by: oci-service-operator