Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.GenerativeAi.getAgentAgentEndpoint
Explore with Pulumi AI
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:
- Agent
Endpoint stringId - The OCID of the endpoint.
- Agent
Endpoint stringId - The OCID of the endpoint.
- agent
Endpoint StringId - The OCID of the endpoint.
- agent
Endpoint stringId - The OCID of the endpoint.
- agent_
endpoint_ strid - The OCID of the endpoint.
- agent
Endpoint StringId - The OCID of the endpoint.
getAgentAgentEndpoint Result
The following output properties are available:
- Agent
Endpoint stringId - Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - The OCID of the compartment.
- Content
Moderation List<GetConfigs Agent Agent Endpoint 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 user-friendly name. Does not have to be unique, and it's changeable.
- 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 Endpoint 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
- The current state of the endpoint.
- 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
Endpoint stringId - Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - The OCID of the compartment.
- Content
Moderation []GetConfigs Agent Agent Endpoint 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 user-friendly name. Does not have to be unique, and it's changeable.
- 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 Endpoint 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
- The current state of the endpoint.
- 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
Endpoint StringId - agent
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - The OCID of the compartment.
- content
Moderation List<GetConfigs Agent Agent Endpoint 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 user-friendly name. Does not have to be unique, and it's changeable.
- 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 Endpoint 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
- The current state of the endpoint.
- 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
Endpoint stringId - agent
Id string - The OCID of the agent that this endpoint is associated with.
- compartment
Id string - The OCID of the compartment.
- content
Moderation GetConfigs Agent Agent Endpoint 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 user-friendly name. Does not have to be unique, and it's changeable.
- {[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 Endpoint 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
- The current state of the endpoint.
- {[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_
endpoint_ strid - agent_
id str - The OCID of the agent that this endpoint is associated with.
- compartment_
id str - The OCID of the compartment.
- content_
moderation_ Sequence[generativeai.configs Get Agent Agent Endpoint 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 user-friendly name. Does not have to be unique, and it's changeable.
- 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 Endpoint 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
- The current state of the endpoint.
- 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
Endpoint StringId - agent
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - The OCID of the compartment.
- 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 user-friendly name. Does not have to be unique, and it's changeable.
- 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
- The current state of the endpoint.
- 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
Supporting Types
GetAgentAgentEndpointContentModerationConfig
- 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.
GetAgentAgentEndpointSessionConfig
- 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.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.