Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.GenerativeAi.getAgentAgentEndpoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

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

const testAgentEndpoints = oci.GenerativeAi.getAgentAgentEndpoints({
    agentId: testAgent.id,
    compartmentId: compartmentId,
    displayName: agentEndpointDisplayName,
    state: agentEndpointState,
});

import pulumi
import pulumi_oci as oci

test_agent_endpoints = oci.GenerativeAi.get_agent_agent_endpoints(agent_id=test_agent["id"],
    compartment_id=compartment_id,
    display_name=agent_endpoint_display_name,
    state=agent_endpoint_state)

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.GetAgentAgentEndpoints(ctx, &generativeai.GetAgentAgentEndpointsArgs{
			AgentId:       pulumi.StringRef(testAgent.Id),
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(agentEndpointDisplayName),
			State:         pulumi.StringRef(agentEndpointState),
		}, 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 testAgentEndpoints = Oci.GenerativeAi.GetAgentAgentEndpoints.Invoke(new()
    {
        AgentId = testAgent.Id,
        CompartmentId = compartmentId,
        DisplayName = agentEndpointDisplayName,
        State = agentEndpointState,
    });

});

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.GetAgentAgentEndpointsArgs;
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 testAgentEndpoints = GenerativeAiFunctions.getAgentAgentEndpoints(GetAgentAgentEndpointsArgs.builder()
            .agentId(testAgent.id())
            .compartmentId(compartmentId)
            .displayName(agentEndpointDisplayName)
            .state(agentEndpointState)
            .build());

    }
}

variables:
  testAgentEndpoints:
    fn::invoke:
      Function: oci:GenerativeAi:getAgentAgentEndpoints
      Arguments:
        agentId: ${testAgent.id}
        compartmentId: ${compartmentId}
        displayName: ${agentEndpointDisplayName}
        state: ${agentEndpointState}

Using getAgentAgentEndpoints

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 getAgentAgentEndpoints(args: GetAgentAgentEndpointsArgs, opts?: InvokeOptions): Promise<GetAgentAgentEndpointsResult>
function getAgentAgentEndpointsOutput(args: GetAgentAgentEndpointsOutputArgs, opts?: InvokeOptions): Output<GetAgentAgentEndpointsResult>

def get_agent_agent_endpoints(agent_id: Optional[str] = None,
                              compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              filters: Optional[Sequence[_generativeai.GetAgentAgentEndpointsFilter]] = None,
                              state: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAgentAgentEndpointsResult
def get_agent_agent_endpoints_output(agent_id: Optional[pulumi.Input[str]] = None,
                              compartment_id: Optional[pulumi.Input[str]] = None,
                              display_name: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[_generativeai.GetAgentAgentEndpointsFilterArgs]]]] = None,
                              state: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAgentAgentEndpointsResult]

func GetAgentAgentEndpoints(ctx *Context, args *GetAgentAgentEndpointsArgs, opts ...InvokeOption) (*GetAgentAgentEndpointsResult, error)
func GetAgentAgentEndpointsOutput(ctx *Context, args *GetAgentAgentEndpointsOutputArgs, opts ...InvokeOption) GetAgentAgentEndpointsResultOutput

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

public static class GetAgentAgentEndpoints 
{
    public static Task<GetAgentAgentEndpointsResult> InvokeAsync(GetAgentAgentEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentAgentEndpointsResult> Invoke(GetAgentAgentEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAgentAgentEndpointsResult> getAgentAgentEndpoints(GetAgentAgentEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

AgentId string: The OCID of the agent.
CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetAgentAgentEndpointsFilter>
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

AgentId string: The OCID of the agent.
CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetAgentAgentEndpointsFilter
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

agentId String: The OCID of the agent.
compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetAgentAgentEndpointsFilter>
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

agentId string: The OCID of the agent.
compartmentId string: The OCID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetAgentAgentEndpointsFilter[]
state string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

agent_id str: The OCID of the agent.
compartment_id str: The OCID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[generativeai.GetAgentAgentEndpointsFilter]
state str: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

agentId String: The OCID of the agent.
compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

getAgentAgentEndpoints Result

The following output properties are available:

AgentEndpointCollections List<GetAgentAgentEndpointsAgentEndpointCollection>: The list of agent_endpoint_collection.
Id string: The provider-assigned unique ID for this managed resource.
AgentId string: The OCID of the agent that this endpoint is associated with.
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
Filters List<GetAgentAgentEndpointsFilter>
State string: The current state of the endpoint.

AgentEndpointCollections []GetAgentAgentEndpointsAgentEndpointCollection: The list of agent_endpoint_collection.
Id string: The provider-assigned unique ID for this managed resource.
AgentId string: The OCID of the agent that this endpoint is associated with.
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
Filters []GetAgentAgentEndpointsFilter
State string: The current state of the endpoint.

agentEndpointCollections List<GetAgentAgentEndpointsAgentEndpointCollection>: The list of agent_endpoint_collection.
id String: The provider-assigned unique ID for this managed resource.
agentId String: The OCID of the agent that this endpoint is associated with.
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
filters List<GetAgentAgentEndpointsFilter>
state String: The current state of the endpoint.

agentEndpointCollections GetAgentAgentEndpointsAgentEndpointCollection[]: The list of agent_endpoint_collection.
id string: The provider-assigned unique ID for this managed resource.
agentId string: The OCID of the agent that this endpoint is associated with.
compartmentId string: The OCID of the compartment.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable.
filters GetAgentAgentEndpointsFilter[]
state string: The current state of the endpoint.

agent_endpoint_collections Sequence[generativeai.GetAgentAgentEndpointsAgentEndpointCollection]: The list of agent_endpoint_collection.
id str: The provider-assigned unique ID for this managed resource.
agent_id str: The OCID of the agent that this endpoint is associated with.
compartment_id str: The OCID of the compartment.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable.
filters Sequence[generativeai.GetAgentAgentEndpointsFilter]
state str: The current state of the endpoint.

agentEndpointCollections List<Property Map>: The list of agent_endpoint_collection.
id String: The provider-assigned unique ID for this managed resource.
agentId String: The OCID of the agent that this endpoint is associated with.
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
filters List<Property Map>
state String: The current state of the endpoint.

Supporting Types

GetAgentAgentEndpointsAgentEndpointCollection

Items List<GetAgentAgentEndpointsAgentEndpointCollectionItem>

Items []GetAgentAgentEndpointsAgentEndpointCollectionItem

items List<GetAgentAgentEndpointsAgentEndpointCollectionItem>

items GetAgentAgentEndpointsAgentEndpointCollectionItem[]

items Sequence[generativeai.GetAgentAgentEndpointsAgentEndpointCollectionItem]

items List<Property Map>

GetAgentAgentEndpointsAgentEndpointCollectionItem

AgentId string: The OCID of the agent.
CompartmentId string: The OCID of the compartment in which to list resources.
ContentModerationConfigs List<GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig>: 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 filter to return only resources that match the given display name exactly.
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<GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig>: 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: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
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

AgentId string: The OCID of the agent.
CompartmentId string: The OCID of the compartment in which to list resources.
ContentModerationConfigs []GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig: 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 filter to return only resources that match the given display name exactly.
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 []GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig: 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: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
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

agentId String: The OCID of the agent.
compartmentId String: The OCID of the compartment in which to list resources.
contentModerationConfigs List<GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig>: 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 filter to return only resources that match the given display name exactly.
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<GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig>: 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: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
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

agentId string: The OCID of the agent.
compartmentId string: The OCID of the compartment in which to list resources.
contentModerationConfigs GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig[]: 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 filter to return only resources that match the given display name exactly.
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 GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig[]: 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: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
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_id str: The OCID of the agent.
compartment_id str: The OCID of the compartment in which to list resources.
content_moderation_configs Sequence[generativeai.GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig]: 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 filter to return only resources that match the given display name exactly.
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.GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig]: 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: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
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

agentId String: The OCID of the agent.
compartmentId String: The OCID of the compartment in which to list resources.
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 filter to return only resources that match the given display name exactly.
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: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
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

GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig

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.

GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig

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.

GetAgentAgentEndpointsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.GenerativeAi.getAgentAgentEndpoints

On this page

On this page

Example Usage

Using getAgentAgentEndpoints

getAgentAgentEndpoints Result

Supporting Types

GetAgentAgentEndpointsAgentEndpointCollection

GetAgentAgentEndpointsAgentEndpointCollectionItem

GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig

GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig

GetAgentAgentEndpointsFilter

Package Details

On this page

On this page