Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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).

Properties

compartmentId

compartmentId: string

The compartment OCID to create the endpoint in.

Optional contentModerationConfig

contentModerationConfig: model.ContentModerationConfig

dedicatedAiClusterId

dedicatedAiClusterId: string

The OCID of the dedicated AI cluster on which the model will be deployed to.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

An optional description of the endpoint.

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable.

Optional freeformTags

freeformTags: undefined | object

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.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

An OCID that uniquely identifies this endpoint resource.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state of the endpoint in more detail that can provide actionable information.

lifecycleState

lifecycleState: LifecycleState

The current state of the endpoint.

modelId

modelId: string

The OCID of the model that's used to create this endpoint.

Optional previousState

previousState: model.Endpoint

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

timeCreated

timeCreated: Date

The date and time that the endpoint was created in the format of an RFC3339 datetime string.

Optional timeUpdated

timeUpdated: Date

The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Endpoint): object

getJsonObj