import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Endpoint resource in Oracle Cloud Infrastructure Generative AI service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/generative-ai/latest/Endpoint * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/generative_ai * * 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 * * ```typescript * 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 === "true", * mode: endpointContentModerationConfigMode, * modelId: testModel.id, * }, * definedTags: { * "Operations.CostCenter": "42", * }, * description: endpointDescription, * displayName: endpointDisplayName, * freeformTags: { * Department: "Finance", * }, * generativeAiPrivateEndpointId: testGenerativeAiPrivateEndpoint.id, * }); * ``` * * ## Import * * Endpoints can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:GenerativeAi/endpoint:Endpoint test_endpoint "id" * ``` */ export declare class Endpoint extends pulumi.CustomResource { /** * Get an existing Endpoint resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: EndpointState, opts?: pulumi.CustomResourceOptions): Endpoint; /** * Returns true if the given object is an instance of Endpoint. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Endpoint; /** * (Updatable) The compartment OCID to create the endpoint in. */ readonly compartmentId: pulumi.Output; /** * (Updatable) The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. */ readonly contentModerationConfig: pulumi.Output; /** * The OCID of the dedicated AI cluster on which a model will be deployed to. */ readonly dedicatedAiClusterId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) An optional description of the endpoint. */ readonly description: pulumi.Output; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. */ readonly displayName: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The OCID of the Generative AI private endpoint to which this endpoint is attached to. */ readonly generativeAiPrivateEndpointId: pulumi.Output; /** * A message describing the current state of the endpoint in more detail that can provide actionable information. */ readonly lifecycleDetails: pulumi.Output; /** * The OCID 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 */ readonly modelId: pulumi.Output; /** * The current state of the endpoint. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time that the endpoint was created in the format of an RFC3339 datetime string. */ readonly timeCreated: pulumi.Output; /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime string. */ readonly timeUpdated: pulumi.Output; /** * Create a Endpoint resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: EndpointArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Endpoint resources. */ export interface EndpointState { /** * (Updatable) The compartment OCID to create the endpoint in. */ compartmentId?: pulumi.Input; /** * (Updatable) The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. */ contentModerationConfig?: pulumi.Input; /** * The OCID of the dedicated AI cluster on which a model will be deployed to. */ dedicatedAiClusterId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) An optional description of the endpoint. */ description?: pulumi.Input; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. */ displayName?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The OCID of the Generative AI private endpoint to which this endpoint is attached to. */ generativeAiPrivateEndpointId?: pulumi.Input; /** * A message describing the current state of the endpoint in more detail that can provide actionable information. */ lifecycleDetails?: pulumi.Input; /** * The OCID 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 */ modelId?: pulumi.Input; /** * The current state of the endpoint. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time that the endpoint was created in the format of an RFC3339 datetime string. */ timeCreated?: pulumi.Input; /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime string. */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a Endpoint resource. */ export interface EndpointArgs { /** * (Updatable) The compartment OCID to create the endpoint in. */ compartmentId: pulumi.Input; /** * (Updatable) The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. */ contentModerationConfig?: pulumi.Input; /** * The OCID of the dedicated AI cluster on which a model will be deployed to. */ dedicatedAiClusterId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) An optional description of the endpoint. */ description?: pulumi.Input; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. */ displayName?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The OCID of the Generative AI private endpoint to which this endpoint is attached to. */ generativeAiPrivateEndpointId?: pulumi.Input; /** * The OCID 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 */ modelId: pulumi.Input; } //# sourceMappingURL=endpoint.d.ts.map