Generative AI: Endpoint¶
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 | Endpoint |
| 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_endpoint.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 |
|---|---|---|---|
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 |
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 |
|---|---|---|---|
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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/generativeai_v1beta1_endpoint.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, model, and DedicatedAiCluster OCIDs before running e2e.
# The controller may bind an existing Endpoint only when the returned OCI list item
# matches spec.compartmentId, spec.modelId, spec.dedicatedAiClusterId, and any
# populated spec.displayName.
#
apiVersion: generativeai.oracle.com/v1beta1
kind: Endpoint
metadata:
name: endpoint-sample
spec:
compartmentId: ocid1.compartment.oc1..exampleuniqueID
modelId: ocid1.generativeaimodel.oc1..exampleuniqueID
dedicatedAiClusterId: ocid1.generativeaidedicatedaicluster.oc1..exampleuniqueID
displayName: osok-endpoint-sample
description: OSOK Endpoint sample
contentModerationConfig:
isEnabled: false
freeformTags:
managed-by: oci-service-operator