oci.GenerativeAi.Endpoint
Explore with Pulumi AI
This resource provides the Endpoint resource in Oracle Cloud Infrastructure Generative AI service.
Creates an endpoint.
The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testEndpoint = new oci.generativeai.Endpoint("test_endpoint", {
    compartmentId: compartmentId,
    dedicatedAiClusterId: testDedicatedAiCluster.id,
    modelId: testModel.id,
    contentModerationConfig: {
        isEnabled: endpointContentModerationConfigIsEnabled,
    },
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: endpointDescription,
    displayName: endpointDisplayName,
    freeformTags: {
        Department: "Finance",
    },
});
import pulumi
import pulumi_oci as oci
test_endpoint = oci.generative_ai.Endpoint("test_endpoint",
    compartment_id=compartment_id,
    dedicated_ai_cluster_id=test_dedicated_ai_cluster["id"],
    model_id=test_model["id"],
    content_moderation_config={
        "is_enabled": endpoint_content_moderation_config_is_enabled,
    },
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=endpoint_description,
    display_name=endpoint_display_name,
    freeform_tags={
        "Department": "Finance",
    })
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.NewEndpoint(ctx, "test_endpoint", &generativeai.EndpointArgs{
			CompartmentId:        pulumi.Any(compartmentId),
			DedicatedAiClusterId: pulumi.Any(testDedicatedAiCluster.Id),
			ModelId:              pulumi.Any(testModel.Id),
			ContentModerationConfig: &generativeai.EndpointContentModerationConfigArgs{
				IsEnabled: pulumi.Any(endpointContentModerationConfigIsEnabled),
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(endpointDescription),
			DisplayName: pulumi.Any(endpointDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testEndpoint = new Oci.GenerativeAi.Endpoint("test_endpoint", new()
    {
        CompartmentId = compartmentId,
        DedicatedAiClusterId = testDedicatedAiCluster.Id,
        ModelId = testModel.Id,
        ContentModerationConfig = new Oci.GenerativeAi.Inputs.EndpointContentModerationConfigArgs
        {
            IsEnabled = endpointContentModerationConfigIsEnabled,
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = endpointDescription,
        DisplayName = endpointDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.Endpoint;
import com.pulumi.oci.GenerativeAi.EndpointArgs;
import com.pulumi.oci.GenerativeAi.inputs.EndpointContentModerationConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var testEndpoint = new Endpoint("testEndpoint", EndpointArgs.builder()
            .compartmentId(compartmentId)
            .dedicatedAiClusterId(testDedicatedAiCluster.id())
            .modelId(testModel.id())
            .contentModerationConfig(EndpointContentModerationConfigArgs.builder()
                .isEnabled(endpointContentModerationConfigIsEnabled)
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(endpointDescription)
            .displayName(endpointDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .build());
    }
}
resources:
  testEndpoint:
    type: oci:GenerativeAi:Endpoint
    name: test_endpoint
    properties:
      compartmentId: ${compartmentId}
      dedicatedAiClusterId: ${testDedicatedAiCluster.id}
      modelId: ${testModel.id}
      contentModerationConfig:
        isEnabled: ${endpointContentModerationConfigIsEnabled}
      definedTags:
        Operations.CostCenter: '42'
      description: ${endpointDescription}
      displayName: ${endpointDisplayName}
      freeformTags:
        Department: Finance
Create Endpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)
@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             compartment_id: Optional[str] = None,
             dedicated_ai_cluster_id: Optional[str] = None,
             model_id: Optional[str] = None,
             content_moderation_config: Optional[EndpointContentModerationConfigArgs] = None,
             defined_tags: Optional[Mapping[str, str]] = None,
             description: Optional[str] = None,
             display_name: Optional[str] = None,
             freeform_tags: Optional[Mapping[str, str]] = None)func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
type: oci:GenerativeAi:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var ociEndpointResource = new Oci.GenerativeAi.Endpoint("ociEndpointResource", new()
{
    CompartmentId = "string",
    DedicatedAiClusterId = "string",
    ModelId = "string",
    ContentModerationConfig = new Oci.GenerativeAi.Inputs.EndpointContentModerationConfigArgs
    {
        IsEnabled = false,
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});
example, err := generativeai.NewEndpoint(ctx, "ociEndpointResource", &generativeai.EndpointArgs{
	CompartmentId:        pulumi.String("string"),
	DedicatedAiClusterId: pulumi.String("string"),
	ModelId:              pulumi.String("string"),
	ContentModerationConfig: &generativeai.EndpointContentModerationConfigArgs{
		IsEnabled: pulumi.Bool(false),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var ociEndpointResource = new com.pulumi.oci.GenerativeAi.Endpoint("ociEndpointResource", com.pulumi.oci.GenerativeAi.EndpointArgs.builder()
    .compartmentId("string")
    .dedicatedAiClusterId("string")
    .modelId("string")
    .contentModerationConfig(EndpointContentModerationConfigArgs.builder()
        .isEnabled(false)
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());
oci_endpoint_resource = oci.generative_ai.Endpoint("ociEndpointResource",
    compartment_id="string",
    dedicated_ai_cluster_id="string",
    model_id="string",
    content_moderation_config={
        "is_enabled": False,
    },
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    })
const ociEndpointResource = new oci.generativeai.Endpoint("ociEndpointResource", {
    compartmentId: "string",
    dedicatedAiClusterId: "string",
    modelId: "string",
    contentModerationConfig: {
        isEnabled: false,
    },
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});
type: oci:GenerativeAi:Endpoint
properties:
    compartmentId: string
    contentModerationConfig:
        isEnabled: false
    dedicatedAiClusterId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    modelId: string
Endpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Endpoint resource accepts the following input properties:
- CompartmentId string
- (Updatable) The compartment OCID to create the endpoint in.
- DedicatedAi stringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- ModelId string
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- ContentModeration EndpointConfig Content Moderation Config 
- (Updatable) 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.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Description string
- (Updatable) An optional description of the endpoint.
- DisplayName string
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Dictionary<string, string>
- (Updatable) 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: {"Department": "Finance"}
- CompartmentId string
- (Updatable) The compartment OCID to create the endpoint in.
- DedicatedAi stringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- ModelId string
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- ContentModeration EndpointConfig Content Moderation Config Args 
- (Updatable) 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.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Description string
- (Updatable) An optional description of the endpoint.
- DisplayName string
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- map[string]string
- (Updatable) 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: {"Department": "Finance"}
- compartmentId String
- (Updatable) The compartment OCID to create the endpoint in.
- dedicatedAi StringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- modelId String
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- contentModeration EndpointConfig Content Moderation Config 
- (Updatable) 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.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description String
- (Updatable) An optional description of the endpoint.
- displayName String
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Map<String,String>
- (Updatable) 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: {"Department": "Finance"}
- compartmentId string
- (Updatable) The compartment OCID to create the endpoint in.
- dedicatedAi stringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- modelId string
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- contentModeration EndpointConfig Content Moderation Config 
- (Updatable) 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.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description string
- (Updatable) An optional description of the endpoint.
- displayName string
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- {[key: string]: string}
- (Updatable) 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: {"Department": "Finance"}
- compartment_id str
- (Updatable) The compartment OCID to create the endpoint in.
- dedicated_ai_ strcluster_ id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- model_id str
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- content_moderation_ Endpointconfig Content Moderation Config Args 
- (Updatable) 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.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description str
- (Updatable) An optional description of the endpoint.
- display_name str
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Mapping[str, str]
- (Updatable) 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: {"Department": "Finance"}
- compartmentId String
- (Updatable) The compartment OCID to create the endpoint in.
- dedicatedAi StringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- modelId String
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- contentModeration Property MapConfig 
- (Updatable) 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.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description String
- (Updatable) An optional description of the endpoint.
- displayName String
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Map<String>
- (Updatable) 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: {"Department": "Finance"}
Outputs
All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- State string
- The current state of the endpoint.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- TimeUpdated string
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- State string
- The current state of the endpoint.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- TimeUpdated string
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- state String
- The current state of the endpoint.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- timeUpdated String
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- state string
- The current state of the endpoint.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- timeUpdated string
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- state str
- The current state of the endpoint.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- time_updated str
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- state String
- The current state of the endpoint.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- timeUpdated String
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
Look up Existing Endpoint Resource
Get an existing Endpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        content_moderation_config: Optional[EndpointContentModerationConfigArgs] = None,
        dedicated_ai_cluster_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        model_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Endpointfunc GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)resources:  _:    type: oci:GenerativeAi:Endpoint    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- CompartmentId string
- (Updatable) The compartment OCID to create the endpoint in.
- ContentModeration EndpointConfig Content Moderation Config 
- (Updatable) 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.
- DedicatedAi stringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Description string
- (Updatable) An optional description of the endpoint.
- DisplayName string
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Dictionary<string, string>
- (Updatable) 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: {"Department": "Finance"}
- LifecycleDetails string
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- ModelId string
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- State string
- The current state of the endpoint.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- TimeUpdated string
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- CompartmentId string
- (Updatable) The compartment OCID to create the endpoint in.
- ContentModeration EndpointConfig Content Moderation Config Args 
- (Updatable) 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.
- DedicatedAi stringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Description string
- (Updatable) An optional description of the endpoint.
- DisplayName string
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- map[string]string
- (Updatable) 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: {"Department": "Finance"}
- LifecycleDetails string
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- ModelId string
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- State string
- The current state of the endpoint.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- TimeUpdated string
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- compartmentId String
- (Updatable) The compartment OCID to create the endpoint in.
- contentModeration EndpointConfig Content Moderation Config 
- (Updatable) 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.
- dedicatedAi StringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description String
- (Updatable) An optional description of the endpoint.
- displayName String
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Map<String,String>
- (Updatable) 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: {"Department": "Finance"}
- lifecycleDetails String
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- modelId String
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state String
- The current state of the endpoint.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- timeUpdated String
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- compartmentId string
- (Updatable) The compartment OCID to create the endpoint in.
- contentModeration EndpointConfig Content Moderation Config 
- (Updatable) 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.
- dedicatedAi stringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description string
- (Updatable) An optional description of the endpoint.
- displayName string
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- {[key: string]: string}
- (Updatable) 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: {"Department": "Finance"}
- lifecycleDetails string
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- modelId string
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state string
- The current state of the endpoint.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- timeUpdated string
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- compartment_id str
- (Updatable) The compartment OCID to create the endpoint in.
- content_moderation_ Endpointconfig Content Moderation Config Args 
- (Updatable) 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.
- dedicated_ai_ strcluster_ id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description str
- (Updatable) An optional description of the endpoint.
- display_name str
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Mapping[str, str]
- (Updatable) 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: {"Department": "Finance"}
- lifecycle_details str
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- model_id str
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state str
- The current state of the endpoint.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- time_updated str
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
- compartmentId String
- (Updatable) The compartment OCID to create the endpoint in.
- contentModeration Property MapConfig 
- (Updatable) 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.
- dedicatedAi StringCluster Id 
- The OCID of the dedicated AI cluster on which a model will be deployed to.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description String
- (Updatable) An optional description of the endpoint.
- displayName String
- (Updatable) A user-friendly name. Does not have to be unique, and it's changeable.
- Map<String>
- (Updatable) 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: {"Department": "Finance"}
- lifecycleDetails String
- A message describing the current state of the endpoint in more detail that can provide actionable information.
- modelId String
- The ID of the model that's used to create this endpoint. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state String
- The current state of the endpoint.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time that the endpoint was created in the format of an RFC3339 datetime string.
- timeUpdated String
- The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
Supporting Types
EndpointContentModerationConfig, EndpointContentModerationConfigArgs        
- IsEnabled bool
- (Updatable) Whether to enable the content moderation feature.
- IsEnabled bool
- (Updatable) Whether to enable the content moderation feature.
- isEnabled Boolean
- (Updatable) Whether to enable the content moderation feature.
- isEnabled boolean
- (Updatable) Whether to enable the content moderation feature.
- is_enabled bool
- (Updatable) Whether to enable the content moderation feature.
- isEnabled Boolean
- (Updatable) Whether to enable the content moderation feature.
Import
Endpoints can be imported using the id, e.g.
$ pulumi import oci:GenerativeAi/endpoint:Endpoint test_endpoint "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.