Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.GenerativeAi.getAgentAgentEndpoints
Explore with Pulumi AI
This data source provides the list of Agent Endpoints in Oracle Cloud Infrastructure Generative Ai Agent service.
ListAgentEndpoints
Gets a list of endpoints.
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:
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Agent Agent Endpoints Filter> - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Agent Agent Endpoints Filter - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Agent Agent Endpoints Filter> - state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent
Id string - The OCID of the agent.
- compartment
Id string - The OCID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Agent Agent Endpoints Filter[] - 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.
Get Agent Agent Endpoints Filter] - state str
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name 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:
- Agent
Endpoint List<GetCollections Agent Agent Endpoints Agent Endpoint Collection> - The list of agent_endpoint_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
List<Get
Agent Agent Endpoints Filter> - State string
- The current state of the endpoint.
- Agent
Endpoint []GetCollections Agent Agent Endpoints Agent Endpoint Collection - The list of agent_endpoint_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
[]Get
Agent Agent Endpoints Filter - State string
- The current state of the endpoint.
- agent
Endpoint List<GetCollections Agent Agent Endpoints Agent Endpoint Collection> - The list of agent_endpoint_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- agent
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
List<Get
Agent Agent Endpoints Filter> - state String
- The current state of the endpoint.
- agent
Endpoint GetCollections Agent Agent Endpoints Agent Endpoint Collection[] - The list of agent_endpoint_collection.
- id string
- The provider-assigned unique ID for this managed resource.
- agent
Id string - The OCID of the agent that this endpoint is associated with.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
Get
Agent Agent Endpoints Filter[] - state string
- The current state of the endpoint.
- agent_
endpoint_ Sequence[generativeai.collections Get Agent Agent Endpoints Agent Endpoint Collection] - 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.
Get Agent Agent Endpoints Filter] - state str
- The current state of the endpoint.
- agent
Endpoint List<Property Map>Collections - The list of agent_endpoint_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- agent
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - The OCID of the compartment.
- display
Name 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
GetAgentAgentEndpointsAgentEndpointCollectionItem
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Content
Moderation List<GetConfigs Agent Agent Endpoints Agent Endpoint Collection Item Content Moderation Config> - 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.
- 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.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- 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.
- Lifecycle
Details 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.
- Session
Configs List<GetAgent Agent Endpoints Agent Endpoint Collection Item Session Config> - SessionConfig
- Should
Enable boolCitation - Whether to show citations in the chat result.
- Should
Enable boolSession - Whether or not to enable Session-based chat.
- Should
Enable boolTrace - 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.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated 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 string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Content
Moderation []GetConfigs Agent Agent Endpoints Agent Endpoint Collection Item Content Moderation Config - 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.
- 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.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- 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.
- Lifecycle
Details 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.
- Session
Configs []GetAgent Agent Endpoints Agent Endpoint Collection Item Session Config - SessionConfig
- Should
Enable boolCitation - Whether to show citations in the chat result.
- Should
Enable boolSession - Whether or not to enable Session-based chat.
- Should
Enable boolTrace - 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.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated 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 String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- content
Moderation List<GetConfigs Agent Agent Endpoints Agent Endpoint Collection Item Content Moderation Config> - 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.
- 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.
- display
Name String - A filter to return only resources that match the given display name exactly.
- 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.
- lifecycle
Details 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.
- session
Configs List<GetAgent Agent Endpoints Agent Endpoint Collection Item Session Config> - SessionConfig
- should
Enable BooleanCitation - Whether to show citations in the chat result.
- should
Enable BooleanSession - Whether or not to enable Session-based chat.
- should
Enable BooleanTrace - 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.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated 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 string - The OCID of the agent.
- compartment
Id string - The OCID of the compartment in which to list resources.
- content
Moderation GetConfigs Agent Agent Endpoints Agent Endpoint Collection Item Content Moderation Config[] - 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.
- {[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.
- display
Name string - A filter to return only resources that match the given display name exactly.
- {[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.
- lifecycle
Details 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.
- session
Configs GetAgent Agent Endpoints Agent Endpoint Collection Item Session Config[] - SessionConfig
- should
Enable booleanCitation - Whether to show citations in the chat result.
- should
Enable booleanSession - Whether or not to enable Session-based chat.
- should
Enable booleanTrace - 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.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated 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_ Sequence[generativeai.configs Get Agent Agent Endpoints Agent Endpoint Collection Item Content Moderation Config] - 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.
- 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.
- 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.Get Agent Agent Endpoints Agent Endpoint Collection Item Session Config] - SessionConfig
- should_
enable_ boolcitation - Whether to show citations in the chat result.
- should_
enable_ boolsession - Whether or not to enable Session-based chat.
- should_
enable_ booltrace - 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.
- 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
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- content
Moderation List<Property Map>Configs - 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.
- 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.
- display
Name String - A filter to return only resources that match the given display name exactly.
- 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.
- lifecycle
Details 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.
- session
Configs List<Property Map> - SessionConfig
- should
Enable BooleanCitation - Whether to show citations in the chat result.
- should
Enable BooleanSession - Whether or not to enable Session-based chat.
- should
Enable BooleanTrace - 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.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the endpoint was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig
- Should
Enable boolOn Input - A flag to enable or disable content moderation on input.
- Should
Enable boolOn Output - A flag to enable or disable content moderation on output.
- Should
Enable boolOn Input - A flag to enable or disable content moderation on input.
- Should
Enable boolOn Output - A flag to enable or disable content moderation on output.
- should
Enable BooleanOn Input - A flag to enable or disable content moderation on input.
- should
Enable BooleanOn Output - A flag to enable or disable content moderation on output.
- should
Enable booleanOn Input - A flag to enable or disable content moderation on input.
- should
Enable booleanOn Output - A flag to enable or disable content moderation on output.
- should_
enable_ boolon_ input - A flag to enable or disable content moderation on input.
- should_
enable_ boolon_ output - A flag to enable or disable content moderation on output.
- should
Enable BooleanOn Input - A flag to enable or disable content moderation on input.
- should
Enable BooleanOn Output - A flag to enable or disable content moderation on output.
GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig
- Idle
Timeout intIn Seconds - The session will become inactive after this timeout.
- Idle
Timeout intIn Seconds - The session will become inactive after this timeout.
- idle
Timeout IntegerIn Seconds - The session will become inactive after this timeout.
- idle
Timeout numberIn Seconds - The session will become inactive after this timeout.
- idle_
timeout_ intin_ seconds - The session will become inactive after this timeout.
- idle
Timeout NumberIn Seconds - The session will become inactive after this timeout.
GetAgentAgentEndpointsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.