Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentAgentEndpoint
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.getAgentAgentEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Agent Endpoint resource in Oracle Cloud Infrastructure Generative Ai Agent service.

    GetAgentEndpoint

    Gets information about an endpoint.

    Example Usage

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

const testAgentEndpoint = oci.GenerativeAi.getAgentAgentEndpoint({
    agentEndpointId: testAgentEndpointOciGenerativeAiAgentAgentEndpoint.id,
});

    import pulumi
import pulumi_oci as oci

test_agent_endpoint = oci.GenerativeAi.get_agent_agent_endpoint(agent_endpoint_id=test_agent_endpoint_oci_generative_ai_agent_agent_endpoint["id"])

    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.GetAgentAgentEndpoint(ctx, &generativeai.GetAgentAgentEndpointArgs{
			AgentEndpointId: testAgentEndpointOciGenerativeAiAgentAgentEndpoint.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 testAgentEndpoint = Oci.GenerativeAi.GetAgentAgentEndpoint.Invoke(new()
    {
        AgentEndpointId = testAgentEndpointOciGenerativeAiAgentAgentEndpoint.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.GetAgentAgentEndpointArgs;
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 testAgentEndpoint = GenerativeAiFunctions.getAgentAgentEndpoint(GetAgentAgentEndpointArgs.builder()
            .agentEndpointId(testAgentEndpointOciGenerativeAiAgentAgentEndpoint.id())
            .build());

    }
}

    variables:
  testAgentEndpoint:
    fn::invoke:
      Function: oci:GenerativeAi:getAgentAgentEndpoint
      Arguments:
        agentEndpointId: ${testAgentEndpointOciGenerativeAiAgentAgentEndpoint.id}

    Using getAgentAgentEndpoint

    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 getAgentAgentEndpoint(args: GetAgentAgentEndpointArgs, opts?: InvokeOptions): Promise<GetAgentAgentEndpointResult>
function getAgentAgentEndpointOutput(args: GetAgentAgentEndpointOutputArgs, opts?: InvokeOptions): Output<GetAgentAgentEndpointResult>
    def get_agent_agent_endpoint(agent_endpoint_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAgentAgentEndpointResult
def get_agent_agent_endpoint_output(agent_endpoint_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAgentAgentEndpointResult]
    func GetAgentAgentEndpoint(ctx *Context, args *GetAgentAgentEndpointArgs, opts ...InvokeOption) (*GetAgentAgentEndpointResult, error)
func GetAgentAgentEndpointOutput(ctx *Context, args *GetAgentAgentEndpointOutputArgs, opts ...InvokeOption) GetAgentAgentEndpointResultOutput

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

    public static class GetAgentAgentEndpoint 
{
    public static Task<GetAgentAgentEndpointResult> InvokeAsync(GetAgentAgentEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentAgentEndpointResult> Invoke(GetAgentAgentEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentAgentEndpointResult> getAgentAgentEndpoint(GetAgentAgentEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    AgentEndpointId string
    The OCID of the endpoint.
    AgentEndpointId string
    The OCID of the endpoint.
    agentEndpointId String
    The OCID of the endpoint.
    agentEndpointId string
    The OCID of the endpoint.
    agent_endpoint_id str
    The OCID of the endpoint.
    agentEndpointId String
    The OCID of the endpoint.

    getAgentAgentEndpoint Result

    The following output properties are available:

    AgentEndpointId string
    AgentId string
    The OCID of the agent that this endpoint is associated with.
    CompartmentId string
    The OCID of the compartment.
    ContentModerationConfigs List<GetAgentAgentEndpointContentModerationConfig>
    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
    DefinedTags Dictionary<string, string>
    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.
    FreeformTags Dictionary<string, string>
    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
    The OCID of the endpoint.
    LifecycleDetails string
    A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    SessionConfigs List<GetAgentAgentEndpointSessionConfig>
    SessionConfig
    ShouldEnableCitation bool
    Whether to show citations in the chat result.
    ShouldEnableSession bool
    Whether or not to enable Session-based chat.
    ShouldEnableTrace bool
    Whether to show traces in the chat result.
    State string
    The current state of the endpoint.
    SystemTags 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 the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    AgentEndpointId string
    AgentId string
    The OCID of the agent that this endpoint is associated with.
    CompartmentId string
    The OCID of the compartment.
    ContentModerationConfigs []GetAgentAgentEndpointContentModerationConfig
    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
    DefinedTags map[string]string
    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.
    FreeformTags map[string]string
    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
    The OCID of the endpoint.
    LifecycleDetails string
    A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    SessionConfigs []GetAgentAgentEndpointSessionConfig
    SessionConfig
    ShouldEnableCitation bool
    Whether to show citations in the chat result.
    ShouldEnableSession bool
    Whether or not to enable Session-based chat.
    ShouldEnableTrace bool
    Whether to show traces in the chat result.
    State string
    The current state of the endpoint.
    SystemTags 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 the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    agentEndpointId String
    agentId String
    The OCID of the agent that this endpoint is associated with.
    compartmentId String
    The OCID of the compartment.
    contentModerationConfigs List<GetAgentAgentEndpointContentModerationConfig>
    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
    definedTags Map<String,String>
    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.
    freeformTags Map<String,String>
    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
    The OCID of the endpoint.
    lifecycleDetails String
    A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    sessionConfigs List<GetAgentAgentEndpointSessionConfig>
    SessionConfig
    shouldEnableCitation Boolean
    Whether to show citations in the chat result.
    shouldEnableSession Boolean
    Whether or not to enable Session-based chat.
    shouldEnableTrace Boolean
    Whether to show traces in the chat result.
    state String
    The current state of the endpoint.
    systemTags 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 the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    agentEndpointId string
    agentId string
    The OCID of the agent that this endpoint is associated with.
    compartmentId string
    The OCID of the compartment.
    contentModerationConfigs GetAgentAgentEndpointContentModerationConfig[]
    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
    definedTags {[key: string]: string}
    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.
    freeformTags {[key: string]: string}
    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
    The OCID of the endpoint.
    lifecycleDetails string
    A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    sessionConfigs GetAgentAgentEndpointSessionConfig[]
    SessionConfig
    shouldEnableCitation boolean
    Whether to show citations in the chat result.
    shouldEnableSession boolean
    Whether or not to enable Session-based chat.
    shouldEnableTrace boolean
    Whether to show traces in the chat result.
    state string
    The current state of the endpoint.
    systemTags {[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 the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    agent_endpoint_id str
    agent_id str
    The OCID of the agent that this endpoint is associated with.
    compartment_id str
    The OCID of the compartment.
    content_moderation_configs Sequence[generativeai.GetAgentAgentEndpointContentModerationConfig]
    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
    defined_tags Mapping[str, str]
    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.
    freeform_tags Mapping[str, str]
    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
    The OCID of the endpoint.
    lifecycle_details str
    A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    session_configs Sequence[generativeai.GetAgentAgentEndpointSessionConfig]
    SessionConfig
    should_enable_citation bool
    Whether to show citations in the chat result.
    should_enable_session bool
    Whether or not to enable Session-based chat.
    should_enable_trace bool
    Whether to show traces in the chat result.
    state str
    The current state of the endpoint.
    system_tags 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 the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    agentEndpointId String
    agentId String
    The OCID of the agent that this endpoint is associated with.
    compartmentId String
    The OCID of the compartment.
    contentModerationConfigs List<Property Map>
    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
    definedTags Map<String>
    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.
    freeformTags Map<String>
    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
    The OCID of the endpoint.
    lifecycleDetails String
    A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    sessionConfigs List<Property Map>
    SessionConfig
    shouldEnableCitation Boolean
    Whether to show citations in the chat result.
    shouldEnableSession Boolean
    Whether or not to enable Session-based chat.
    shouldEnableTrace Boolean
    Whether to show traces in the chat result.
    state String
    The current state of the endpoint.
    systemTags 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 the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    GetAgentAgentEndpointContentModerationConfig

    ShouldEnableOnInput bool
    A flag to enable or disable content moderation on input.
    ShouldEnableOnOutput bool
    A flag to enable or disable content moderation on output.
    ShouldEnableOnInput bool
    A flag to enable or disable content moderation on input.
    ShouldEnableOnOutput bool
    A flag to enable or disable content moderation on output.
    shouldEnableOnInput Boolean
    A flag to enable or disable content moderation on input.
    shouldEnableOnOutput Boolean
    A flag to enable or disable content moderation on output.
    shouldEnableOnInput boolean
    A flag to enable or disable content moderation on input.
    shouldEnableOnOutput boolean
    A flag to enable or disable content moderation on output.
    should_enable_on_input bool
    A flag to enable or disable content moderation on input.
    should_enable_on_output bool
    A flag to enable or disable content moderation on output.
    shouldEnableOnInput Boolean
    A flag to enable or disable content moderation on input.
    shouldEnableOnOutput Boolean
    A flag to enable or disable content moderation on output.

    GetAgentAgentEndpointSessionConfig

    IdleTimeoutInSeconds int
    The session will become inactive after this timeout.
    IdleTimeoutInSeconds int
    The session will become inactive after this timeout.
    idleTimeoutInSeconds Integer
    The session will become inactive after this timeout.
    idleTimeoutInSeconds number
    The session will become inactive after this timeout.
    idle_timeout_in_seconds int
    The session will become inactive after this timeout.
    idleTimeoutInSeconds Number
    The session will become inactive after this timeout.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci