Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.GenerativeAi.AgentAgentEndpoint
Explore with Pulumi AI
This resource provides the Agent Endpoint resource in Oracle Cloud Infrastructure Generative Ai Agent service.
CreateAgentEndpoint
Creates an endpoint.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAgentEndpoint = new oci.generativeai.AgentAgentEndpoint("test_agent_endpoint", {
agentId: testAgent.id,
compartmentId: compartmentId,
contentModerationConfig: {
shouldEnableOnInput: agentEndpointContentModerationConfigShouldEnableOnInput,
shouldEnableOnOutput: agentEndpointContentModerationConfigShouldEnableOnOutput,
},
definedTags: {
"Operations.CostCenter": "42",
},
description: agentEndpointDescription,
displayName: agentEndpointDisplayName,
freeformTags: {
Department: "Finance",
},
sessionConfig: {
idleTimeoutInSeconds: agentEndpointSessionConfigIdleTimeoutInSeconds,
},
shouldEnableCitation: agentEndpointShouldEnableCitation,
shouldEnableSession: agentEndpointShouldEnableSession,
shouldEnableTrace: agentEndpointShouldEnableTrace,
});
import pulumi
import pulumi_oci as oci
test_agent_endpoint = oci.generative_ai.AgentAgentEndpoint("test_agent_endpoint",
agent_id=test_agent["id"],
compartment_id=compartment_id,
content_moderation_config={
"should_enable_on_input": agent_endpoint_content_moderation_config_should_enable_on_input,
"should_enable_on_output": agent_endpoint_content_moderation_config_should_enable_on_output,
},
defined_tags={
"Operations.CostCenter": "42",
},
description=agent_endpoint_description,
display_name=agent_endpoint_display_name,
freeform_tags={
"Department": "Finance",
},
session_config={
"idle_timeout_in_seconds": agent_endpoint_session_config_idle_timeout_in_seconds,
},
should_enable_citation=agent_endpoint_should_enable_citation,
should_enable_session=agent_endpoint_should_enable_session,
should_enable_trace=agent_endpoint_should_enable_trace)
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.NewAgentAgentEndpoint(ctx, "test_agent_endpoint", &generativeai.AgentAgentEndpointArgs{
AgentId: pulumi.Any(testAgent.Id),
CompartmentId: pulumi.Any(compartmentId),
ContentModerationConfig: &generativeai.AgentAgentEndpointContentModerationConfigArgs{
ShouldEnableOnInput: pulumi.Any(agentEndpointContentModerationConfigShouldEnableOnInput),
ShouldEnableOnOutput: pulumi.Any(agentEndpointContentModerationConfigShouldEnableOnOutput),
},
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
Description: pulumi.Any(agentEndpointDescription),
DisplayName: pulumi.Any(agentEndpointDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
SessionConfig: &generativeai.AgentAgentEndpointSessionConfigArgs{
IdleTimeoutInSeconds: pulumi.Any(agentEndpointSessionConfigIdleTimeoutInSeconds),
},
ShouldEnableCitation: pulumi.Any(agentEndpointShouldEnableCitation),
ShouldEnableSession: pulumi.Any(agentEndpointShouldEnableSession),
ShouldEnableTrace: pulumi.Any(agentEndpointShouldEnableTrace),
})
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 = new Oci.GenerativeAi.AgentAgentEndpoint("test_agent_endpoint", new()
{
AgentId = testAgent.Id,
CompartmentId = compartmentId,
ContentModerationConfig = new Oci.GenerativeAi.Inputs.AgentAgentEndpointContentModerationConfigArgs
{
ShouldEnableOnInput = agentEndpointContentModerationConfigShouldEnableOnInput,
ShouldEnableOnOutput = agentEndpointContentModerationConfigShouldEnableOnOutput,
},
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
Description = agentEndpointDescription,
DisplayName = agentEndpointDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
SessionConfig = new Oci.GenerativeAi.Inputs.AgentAgentEndpointSessionConfigArgs
{
IdleTimeoutInSeconds = agentEndpointSessionConfigIdleTimeoutInSeconds,
},
ShouldEnableCitation = agentEndpointShouldEnableCitation,
ShouldEnableSession = agentEndpointShouldEnableSession,
ShouldEnableTrace = agentEndpointShouldEnableTrace,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.AgentAgentEndpoint;
import com.pulumi.oci.GenerativeAi.AgentAgentEndpointArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentAgentEndpointContentModerationConfigArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentAgentEndpointSessionConfigArgs;
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) {
var testAgentEndpoint = new AgentAgentEndpoint("testAgentEndpoint", AgentAgentEndpointArgs.builder()
.agentId(testAgent.id())
.compartmentId(compartmentId)
.contentModerationConfig(AgentAgentEndpointContentModerationConfigArgs.builder()
.shouldEnableOnInput(agentEndpointContentModerationConfigShouldEnableOnInput)
.shouldEnableOnOutput(agentEndpointContentModerationConfigShouldEnableOnOutput)
.build())
.definedTags(Map.of("Operations.CostCenter", "42"))
.description(agentEndpointDescription)
.displayName(agentEndpointDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.sessionConfig(AgentAgentEndpointSessionConfigArgs.builder()
.idleTimeoutInSeconds(agentEndpointSessionConfigIdleTimeoutInSeconds)
.build())
.shouldEnableCitation(agentEndpointShouldEnableCitation)
.shouldEnableSession(agentEndpointShouldEnableSession)
.shouldEnableTrace(agentEndpointShouldEnableTrace)
.build());
}
}
resources:
testAgentEndpoint:
type: oci:GenerativeAi:AgentAgentEndpoint
name: test_agent_endpoint
properties:
agentId: ${testAgent.id}
compartmentId: ${compartmentId}
contentModerationConfig:
shouldEnableOnInput: ${agentEndpointContentModerationConfigShouldEnableOnInput}
shouldEnableOnOutput: ${agentEndpointContentModerationConfigShouldEnableOnOutput}
definedTags:
Operations.CostCenter: '42'
description: ${agentEndpointDescription}
displayName: ${agentEndpointDisplayName}
freeformTags:
Department: Finance
sessionConfig:
idleTimeoutInSeconds: ${agentEndpointSessionConfigIdleTimeoutInSeconds}
shouldEnableCitation: ${agentEndpointShouldEnableCitation}
shouldEnableSession: ${agentEndpointShouldEnableSession}
shouldEnableTrace: ${agentEndpointShouldEnableTrace}
Create AgentAgentEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AgentAgentEndpoint(name: string, args: AgentAgentEndpointArgs, opts?: CustomResourceOptions);@overload
def AgentAgentEndpoint(resource_name: str,
args: AgentAgentEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AgentAgentEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[str] = None,
compartment_id: Optional[str] = None,
content_moderation_config: Optional[AgentAgentEndpointContentModerationConfigArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
session_config: Optional[AgentAgentEndpointSessionConfigArgs] = None,
should_enable_citation: Optional[bool] = None,
should_enable_session: Optional[bool] = None,
should_enable_trace: Optional[bool] = None)func NewAgentAgentEndpoint(ctx *Context, name string, args AgentAgentEndpointArgs, opts ...ResourceOption) (*AgentAgentEndpoint, error)public AgentAgentEndpoint(string name, AgentAgentEndpointArgs args, CustomResourceOptions? opts = null)
public AgentAgentEndpoint(String name, AgentAgentEndpointArgs args)
public AgentAgentEndpoint(String name, AgentAgentEndpointArgs args, CustomResourceOptions options)
type: oci:GenerativeAi:AgentAgentEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AgentAgentEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentAgentEndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentAgentEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentAgentEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentAgentEndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var agentAgentEndpointResource = new Oci.GenerativeAi.AgentAgentEndpoint("agentAgentEndpointResource", new()
{
AgentId = "string",
CompartmentId = "string",
ContentModerationConfig = new Oci.GenerativeAi.Inputs.AgentAgentEndpointContentModerationConfigArgs
{
ShouldEnableOnInput = false,
ShouldEnableOnOutput = false,
},
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
SessionConfig = new Oci.GenerativeAi.Inputs.AgentAgentEndpointSessionConfigArgs
{
IdleTimeoutInSeconds = 0,
},
ShouldEnableCitation = false,
ShouldEnableSession = false,
ShouldEnableTrace = false,
});
example, err := generativeai.NewAgentAgentEndpoint(ctx, "agentAgentEndpointResource", &generativeai.AgentAgentEndpointArgs{
AgentId: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
ContentModerationConfig: &generativeai.AgentAgentEndpointContentModerationConfigArgs{
ShouldEnableOnInput: pulumi.Bool(false),
ShouldEnableOnOutput: pulumi.Bool(false),
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
SessionConfig: &generativeai.AgentAgentEndpointSessionConfigArgs{
IdleTimeoutInSeconds: pulumi.Int(0),
},
ShouldEnableCitation: pulumi.Bool(false),
ShouldEnableSession: pulumi.Bool(false),
ShouldEnableTrace: pulumi.Bool(false),
})
var agentAgentEndpointResource = new AgentAgentEndpoint("agentAgentEndpointResource", AgentAgentEndpointArgs.builder()
.agentId("string")
.compartmentId("string")
.contentModerationConfig(AgentAgentEndpointContentModerationConfigArgs.builder()
.shouldEnableOnInput(false)
.shouldEnableOnOutput(false)
.build())
.definedTags(Map.of("string", "string"))
.description("string")
.displayName("string")
.freeformTags(Map.of("string", "string"))
.sessionConfig(AgentAgentEndpointSessionConfigArgs.builder()
.idleTimeoutInSeconds(0)
.build())
.shouldEnableCitation(false)
.shouldEnableSession(false)
.shouldEnableTrace(false)
.build());
agent_agent_endpoint_resource = oci.generative_ai.AgentAgentEndpoint("agentAgentEndpointResource",
agent_id="string",
compartment_id="string",
content_moderation_config={
"should_enable_on_input": False,
"should_enable_on_output": False,
},
defined_tags={
"string": "string",
},
description="string",
display_name="string",
freeform_tags={
"string": "string",
},
session_config={
"idle_timeout_in_seconds": 0,
},
should_enable_citation=False,
should_enable_session=False,
should_enable_trace=False)
const agentAgentEndpointResource = new oci.generativeai.AgentAgentEndpoint("agentAgentEndpointResource", {
agentId: "string",
compartmentId: "string",
contentModerationConfig: {
shouldEnableOnInput: false,
shouldEnableOnOutput: false,
},
definedTags: {
string: "string",
},
description: "string",
displayName: "string",
freeformTags: {
string: "string",
},
sessionConfig: {
idleTimeoutInSeconds: 0,
},
shouldEnableCitation: false,
shouldEnableSession: false,
shouldEnableTrace: false,
});
type: oci:GenerativeAi:AgentAgentEndpoint
properties:
agentId: string
compartmentId: string
contentModerationConfig:
shouldEnableOnInput: false
shouldEnableOnOutput: false
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
sessionConfig:
idleTimeoutInSeconds: 0
shouldEnableCitation: false
shouldEnableSession: false
shouldEnableTrace: false
AgentAgentEndpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AgentAgentEndpoint resource accepts the following input properties:
- Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the endpoint in.
- Content
Moderation AgentConfig Agent Endpoint Content Moderation Config - (Updatable) 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>
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"} - Session
Config AgentAgent Endpoint Session Config (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- Should
Enable boolCitation - (Updatable) Whether to show citations in the chat result.
- Should
Enable boolSession - Whether or not to enable Session-based chat.
- Should
Enable boolTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the endpoint in.
- Content
Moderation AgentConfig Agent Endpoint Content Moderation Config Args - (Updatable) 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
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"} - Session
Config AgentAgent Endpoint Session Config Args (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- Should
Enable boolCitation - (Updatable) Whether to show citations in the chat result.
- Should
Enable boolSession - Whether or not to enable Session-based chat.
- Should
Enable boolTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- agent
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - (Updatable) The OCID of the compartment to create the endpoint in.
- content
Moderation AgentConfig Agent Endpoint Content Moderation Config - (Updatable) 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>
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"} - session
Config AgentAgent Endpoint Session Config (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should
Enable BooleanCitation - (Updatable) Whether to show citations in the chat result.
- should
Enable BooleanSession - Whether or not to enable Session-based chat.
- should
Enable BooleanTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- agent
Id string - The OCID of the agent that this endpoint is associated with.
- compartment
Id string - (Updatable) The OCID of the compartment to create the endpoint in.
- content
Moderation AgentConfig Agent Endpoint Content Moderation Config - (Updatable) 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}
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"} - session
Config AgentAgent Endpoint Session Config (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should
Enable booleanCitation - (Updatable) Whether to show citations in the chat result.
- should
Enable booleanSession - Whether or not to enable Session-based chat.
- should
Enable booleanTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- agent_
id str - The OCID of the agent that this endpoint is associated with.
- compartment_
id str - (Updatable) The OCID of the compartment to create the endpoint in.
- content_
moderation_ Agentconfig Agent Endpoint Content Moderation Config Args - (Updatable) 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]
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"} - session_
config AgentAgent Endpoint Session Config Args (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should_
enable_ boolcitation - (Updatable) Whether to show citations in the chat result.
- should_
enable_ boolsession - Whether or not to enable Session-based chat.
- should_
enable_ booltrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- agent
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - (Updatable) The OCID of the compartment to create the endpoint in.
- content
Moderation Property MapConfig - (Updatable) 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>
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"} - session
Config Property Map (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should
Enable BooleanCitation - (Updatable) Whether to show citations in the chat result.
- should
Enable BooleanSession - Whether or not to enable Session-based chat.
- should
Enable BooleanTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the AgentAgentEndpoint resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- 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
- id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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
- id str
- The provider-assigned unique ID for this managed resource.
- 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.
- 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
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- 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
Look up Existing AgentAgentEndpoint Resource
Get an existing AgentAgentEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AgentAgentEndpointState, opts?: CustomResourceOptions): AgentAgentEndpoint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[str] = None,
compartment_id: Optional[str] = None,
content_moderation_config: Optional[AgentAgentEndpointContentModerationConfigArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
lifecycle_details: Optional[str] = None,
session_config: Optional[AgentAgentEndpointSessionConfigArgs] = None,
should_enable_citation: Optional[bool] = None,
should_enable_session: Optional[bool] = None,
should_enable_trace: Optional[bool] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> AgentAgentEndpointfunc GetAgentAgentEndpoint(ctx *Context, name string, id IDInput, state *AgentAgentEndpointState, opts ...ResourceOption) (*AgentAgentEndpoint, error)public static AgentAgentEndpoint Get(string name, Input<string> id, AgentAgentEndpointState? state, CustomResourceOptions? opts = null)public static AgentAgentEndpoint get(String name, Output<String> id, AgentAgentEndpointState state, CustomResourceOptions options)resources: _: type: oci:GenerativeAi:AgentAgentEndpoint get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Agent
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the endpoint in.
- Content
Moderation AgentConfig Agent Endpoint Content Moderation Config - (Updatable) 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>
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"} - 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
Config AgentAgent Endpoint Session Config (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- Should
Enable boolCitation - (Updatable) Whether to show citations in the chat result.
- Should
Enable boolSession - Whether or not to enable Session-based chat.
- Should
Enable boolTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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
Id string - The OCID of the agent that this endpoint is associated with.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the endpoint in.
- Content
Moderation AgentConfig Agent Endpoint Content Moderation Config Args - (Updatable) 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
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"} - 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
Config AgentAgent Endpoint Session Config Args (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- Should
Enable boolCitation - (Updatable) Whether to show citations in the chat result.
- Should
Enable boolSession - Whether or not to enable Session-based chat.
- Should
Enable boolTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - (Updatable) The OCID of the compartment to create the endpoint in.
- content
Moderation AgentConfig Agent Endpoint Content Moderation Config - (Updatable) 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>
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"} - 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
Config AgentAgent Endpoint Session Config (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should
Enable BooleanCitation - (Updatable) Whether to show citations in the chat result.
- should
Enable BooleanSession - Whether or not to enable Session-based chat.
- should
Enable BooleanTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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
Id string - The OCID of the agent that this endpoint is associated with.
- compartment
Id string - (Updatable) The OCID of the compartment to create the endpoint in.
- content
Moderation AgentConfig Agent Endpoint Content Moderation Config - (Updatable) 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}
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"} - 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
Config AgentAgent Endpoint Session Config (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should
Enable booleanCitation - (Updatable) Whether to show citations in the chat result.
- should
Enable booleanSession - Whether or not to enable Session-based chat.
- should
Enable booleanTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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_
id str - The OCID of the agent that this endpoint is associated with.
- compartment_
id str - (Updatable) The OCID of the compartment to create the endpoint in.
- content_
moderation_ Agentconfig Agent Endpoint Content Moderation Config Args - (Updatable) 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]
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"} - 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_
config AgentAgent Endpoint Session Config Args (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should_
enable_ boolcitation - (Updatable) Whether to show citations in the chat result.
- should_
enable_ boolsession - Whether or not to enable Session-based chat.
- should_
enable_ booltrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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
Id String - The OCID of the agent that this endpoint is associated with.
- compartment
Id String - (Updatable) The OCID of the compartment to create the endpoint in.
- content
Moderation Property MapConfig - (Updatable) 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>
- (Updatable) 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
- (Updatable) An optional description of the endpoint.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"} - 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
Config Property Map (Updatable) SessionConfig
Session Configuration on AgentEndpoint.
- should
Enable BooleanCitation - (Updatable) Whether to show citations in the chat result.
- should
Enable BooleanSession - Whether or not to enable Session-based chat.
- should
Enable BooleanTrace (Updatable) Whether to show traces in the chat result.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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
AgentAgentEndpointContentModerationConfig, AgentAgentEndpointContentModerationConfigArgs
- Should
Enable boolOn Input - (Updatable) A flag to enable or disable content moderation on input.
- Should
Enable boolOn Output - (Updatable) A flag to enable or disable content moderation on output.
- Should
Enable boolOn Input - (Updatable) A flag to enable or disable content moderation on input.
- Should
Enable boolOn Output - (Updatable) A flag to enable or disable content moderation on output.
- should
Enable BooleanOn Input - (Updatable) A flag to enable or disable content moderation on input.
- should
Enable BooleanOn Output - (Updatable) A flag to enable or disable content moderation on output.
- should
Enable booleanOn Input - (Updatable) A flag to enable or disable content moderation on input.
- should
Enable booleanOn Output - (Updatable) A flag to enable or disable content moderation on output.
- should_
enable_ boolon_ input - (Updatable) A flag to enable or disable content moderation on input.
- should_
enable_ boolon_ output - (Updatable) A flag to enable or disable content moderation on output.
- should
Enable BooleanOn Input - (Updatable) A flag to enable or disable content moderation on input.
- should
Enable BooleanOn Output - (Updatable) A flag to enable or disable content moderation on output.
AgentAgentEndpointSessionConfig, AgentAgentEndpointSessionConfigArgs
- Idle
Timeout intIn Seconds - (Updatable) The session will become inactive after this timeout.
- Idle
Timeout intIn Seconds - (Updatable) The session will become inactive after this timeout.
- idle
Timeout IntegerIn Seconds - (Updatable) The session will become inactive after this timeout.
- idle
Timeout numberIn Seconds - (Updatable) The session will become inactive after this timeout.
- idle_
timeout_ intin_ seconds - (Updatable) The session will become inactive after this timeout.
- idle
Timeout NumberIn Seconds - (Updatable) The session will become inactive after this timeout.
Import
AgentEndpoints can be imported using the id, e.g.
$ pulumi import oci:GenerativeAi/agentAgentEndpoint:AgentAgentEndpoint test_agent_endpoint "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.