Oracle Cloud Infrastructure v1.41.0, Jun 19 24

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.GenerativeAi.getEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testEndpoint = oci.GenerativeAi.getEndpoint({
    endpointId: testEndpointOciGenerativeAiEndpoint.id,
});

import pulumi
import pulumi_oci as oci

test_endpoint = oci.GenerativeAi.get_endpoint(endpoint_id=test_endpoint_oci_generative_ai_endpoint["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/GenerativeAi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GenerativeAi.GetEndpoint(ctx, &generativeai.GetEndpointArgs{
			EndpointId: testEndpointOciGenerativeAiEndpoint.Id,
		}, nil)
		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 = Oci.GenerativeAi.GetEndpoint.Invoke(new()
    {
        EndpointId = testEndpointOciGenerativeAiEndpoint.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetEndpointArgs;
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) {
        final var testEndpoint = GenerativeAiFunctions.getEndpoint(GetEndpointArgs.builder()
            .endpointId(testEndpointOciGenerativeAiEndpoint.id())
            .build());

    }
}

variables:
  testEndpoint:
    fn::invoke:
      Function: oci:GenerativeAi:getEndpoint
      Arguments:
        endpointId: ${testEndpointOciGenerativeAiEndpoint.id}

Using getEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>

def get_endpoint(endpoint_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(endpoint_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]

func GetEndpoint(ctx *Context, args *GetEndpointArgs, opts ...InvokeOption) (*GetEndpointResult, error)
func GetEndpointOutput(ctx *Context, args *GetEndpointOutputArgs, opts ...InvokeOption) GetEndpointResultOutput

> Note: This function is named GetEndpoint in the Go SDK.

public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:GenerativeAi/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointId string: The OCID of the endpoint.

EndpointId string: The OCID of the endpoint.

endpointId String: The OCID of the endpoint.

endpointId string: The OCID of the endpoint.

endpoint_id str: The OCID of the endpoint.

endpointId String: The OCID of the endpoint.

getEndpoint Result

The following output properties are available:

CompartmentId string: The compartment OCID to create the endpoint in.
ContentModerationConfigs List<GetEndpointContentModerationConfig>: 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.
DedicatedAiClusterId string: The OCID of the dedicated AI cluster on which the model will be deployed to.
DefinedTags Dictionary<string, object>: 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: An optional description of the endpoint.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
EndpointId string
FreeformTags Dictionary<string, 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: {"Department": "Finance"}
Id string: An OCID that uniquely identifies this endpoint resource.
LifecycleDetails string: A message describing the current state of the endpoint in more detail that can provide actionable information.
ModelId string: The OCID of the model that's used to create this endpoint.
State string: The current state of the endpoint.
SystemTags Dictionary<string, object>: 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: The compartment OCID to create the endpoint in.
ContentModerationConfigs []GetEndpointContentModerationConfig: 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.
DedicatedAiClusterId string: The OCID of the dedicated AI cluster on which the model will be deployed to.
DefinedTags map[string]interface{}: 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: An optional description of the endpoint.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
EndpointId string
FreeformTags map[string]interface{}: 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"}
Id string: An OCID that uniquely identifies this endpoint resource.
LifecycleDetails string: A message describing the current state of the endpoint in more detail that can provide actionable information.
ModelId string: The OCID of the model that's used to create this endpoint.
State string: The current state of the endpoint.
SystemTags map[string]interface{}: 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: The compartment OCID to create the endpoint in.
contentModerationConfigs List<GetEndpointContentModerationConfig>: 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.
dedicatedAiClusterId String: The OCID of the dedicated AI cluster on which the model will be deployed to.
definedTags Map<String,Object>: 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: An optional description of the endpoint.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
endpointId String
freeformTags Map<String,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: {"Department": "Finance"}
id String: An OCID that uniquely identifies this endpoint resource.
lifecycleDetails String: A message describing the current state of the endpoint in more detail that can provide actionable information.
modelId String: The OCID of the model that's used to create this endpoint.
state String: The current state of the endpoint.
systemTags Map<String,Object>: 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: The compartment OCID to create the endpoint in.
contentModerationConfigs GetEndpointContentModerationConfig[]: 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.
dedicatedAiClusterId string: The OCID of the dedicated AI cluster on which the model will be deployed to.
definedTags {[key: string]: any}: 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: An optional description of the endpoint.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable.
endpointId string
freeformTags {[key: string]: any}: 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"}
id string: An OCID that uniquely identifies this endpoint resource.
lifecycleDetails string: A message describing the current state of the endpoint in more detail that can provide actionable information.
modelId string: The OCID of the model that's used to create this endpoint.
state string: The current state of the endpoint.
systemTags {[key: string]: any}: 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: The compartment OCID to create the endpoint in.
content_moderation_configs Sequence[generativeai.GetEndpointContentModerationConfig]: 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_cluster_id str: The OCID of the dedicated AI cluster on which the model will be deployed to.
defined_tags Mapping[str, Any]: 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: An optional description of the endpoint.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable.
endpoint_id str
freeform_tags Mapping[str, Any]: 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"}
id str: An OCID that uniquely identifies this endpoint resource.
lifecycle_details str: A message describing the current state of the endpoint in more detail that can provide actionable information.
model_id str: The OCID of the model that's used to create this endpoint.
state str: The current state of the endpoint.
system_tags Mapping[str, Any]: 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: The compartment OCID to create the endpoint in.
contentModerationConfigs List<Property Map>: 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.
dedicatedAiClusterId String: The OCID of the dedicated AI cluster on which the model will be deployed to.
definedTags Map<Any>: 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: An optional description of the endpoint.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
endpointId String
freeformTags Map<Any>: 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"}
id String: An OCID that uniquely identifies this endpoint resource.
lifecycleDetails String: A message describing the current state of the endpoint in more detail that can provide actionable information.
modelId String: The OCID of the model that's used to create this endpoint.
state String: The current state of the endpoint.
systemTags Map<Any>: 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

GetEndpointContentModerationConfig

IsEnabled bool: Whether to enable the content moderation feature.

IsEnabled bool: Whether to enable the content moderation feature.

isEnabled Boolean: Whether to enable the content moderation feature.

isEnabled boolean: Whether to enable the content moderation feature.

is_enabled bool: Whether to enable the content moderation feature.

isEnabled Boolean: Whether to enable the content moderation feature.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

pulumi/pulumi-oci

oci.GenerativeAi.getEndpoint

On this page

On this page

Example Usage

Using getEndpoint

getEndpoint Result

Supporting Types

GetEndpointContentModerationConfig

Package Details

On this page

On this page