Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. AgentAgentEndpoint
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.AgentAgentEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

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,
});
Copy
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)
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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}
Copy

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[_generativeai.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[_generativeai.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 This property is required. string
The unique name of the resource.
args This property is required. AgentAgentEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. AgentAgentEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AgentAgentEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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,
});
Copy
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),
})
Copy
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());
Copy
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)
Copy
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,
});
Copy
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
Copy

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:

AgentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the agent that this endpoint is associated with.
CompartmentId This property is required. string
(Updatable) The OCID of the compartment to create the endpoint in.
ContentModerationConfig AgentAgentEndpointContentModerationConfig
(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.
DefinedTags 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.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags 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"}
SessionConfig AgentAgentEndpointSessionConfig

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

ShouldEnableCitation bool
(Updatable) Whether to show citations in the chat result.
ShouldEnableSession Changes to this property will trigger replacement. bool
Whether or not to enable Session-based chat.
ShouldEnableTrace bool

(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

AgentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the agent that this endpoint is associated with.
CompartmentId This property is required. string
(Updatable) The OCID of the compartment to create the endpoint in.
ContentModerationConfig AgentAgentEndpointContentModerationConfigArgs
(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.
DefinedTags 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.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags 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"}
SessionConfig AgentAgentEndpointSessionConfigArgs

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

ShouldEnableCitation bool
(Updatable) Whether to show citations in the chat result.
ShouldEnableSession Changes to this property will trigger replacement. bool
Whether or not to enable Session-based chat.
ShouldEnableTrace bool

(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

agentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the agent that this endpoint is associated with.
compartmentId This property is required. String
(Updatable) The OCID of the compartment to create the endpoint in.
contentModerationConfig AgentAgentEndpointContentModerationConfig
(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.
definedTags 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.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags 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"}
sessionConfig AgentAgentEndpointSessionConfig

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

shouldEnableCitation Boolean
(Updatable) Whether to show citations in the chat result.
shouldEnableSession Changes to this property will trigger replacement. Boolean
Whether or not to enable Session-based chat.
shouldEnableTrace Boolean

(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

agentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the agent that this endpoint is associated with.
compartmentId This property is required. string
(Updatable) The OCID of the compartment to create the endpoint in.
contentModerationConfig AgentAgentEndpointContentModerationConfig
(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.
definedTags {[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.
displayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags {[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"}
sessionConfig AgentAgentEndpointSessionConfig

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

shouldEnableCitation boolean
(Updatable) Whether to show citations in the chat result.
shouldEnableSession Changes to this property will trigger replacement. boolean
Whether or not to enable Session-based chat.
shouldEnableTrace boolean

(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
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the agent that this endpoint is associated with.
compartment_id This property is required. str
(Updatable) The OCID of the compartment to create the endpoint in.
content_moderation_config generativeai.AgentAgentEndpointContentModerationConfigArgs
(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.
defined_tags 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.
freeform_tags 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 generativeai.AgentAgentEndpointSessionConfigArgs

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

should_enable_citation bool
(Updatable) Whether to show citations in the chat result.
should_enable_session Changes to this property will trigger replacement. bool
Whether or not to enable Session-based chat.
should_enable_trace bool

(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

agentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the agent that this endpoint is associated with.
compartmentId This property is required. String
(Updatable) The OCID of the compartment to create the endpoint in.
contentModerationConfig Property Map
(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.
definedTags 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.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags 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"}
sessionConfig Property Map

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

shouldEnableCitation Boolean
(Updatable) Whether to show citations in the chat result.
shouldEnableSession Changes to this property will trigger replacement. Boolean
Whether or not to enable Session-based chat.
shouldEnableTrace Boolean

(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.
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.
State string
The current state of the endpoint.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
Id string
The provider-assigned unique ID for this managed resource.
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.
State string
The current state of the endpoint.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
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.
state String
The current state of the endpoint.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
id string
The provider-assigned unique ID for this managed resource.
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.
state string
The current state of the endpoint.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string
The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
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.
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
id String
The provider-assigned unique ID for this managed resource.
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.
state String
The current state of the endpoint.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

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[_generativeai.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[_generativeai.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) -> AgentAgentEndpoint
func 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AgentId Changes to this property will trigger replacement. string
The OCID of the agent that this endpoint is associated with.
CompartmentId string
(Updatable) The OCID of the compartment to create the endpoint in.
ContentModerationConfig AgentAgentEndpointContentModerationConfig
(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.
DefinedTags 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.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags 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"}
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.
SessionConfig AgentAgentEndpointSessionConfig

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

ShouldEnableCitation bool
(Updatable) Whether to show citations in the chat result.
ShouldEnableSession Changes to this property will trigger replacement. bool
Whether or not to enable Session-based chat.
ShouldEnableTrace bool

(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.
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 Changes to this property will trigger replacement. string
The OCID of the agent that this endpoint is associated with.
CompartmentId string
(Updatable) The OCID of the compartment to create the endpoint in.
ContentModerationConfig AgentAgentEndpointContentModerationConfigArgs
(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.
DefinedTags 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.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags 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"}
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.
SessionConfig AgentAgentEndpointSessionConfigArgs

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

ShouldEnableCitation bool
(Updatable) Whether to show citations in the chat result.
ShouldEnableSession Changes to this property will trigger replacement. bool
Whether or not to enable Session-based chat.
ShouldEnableTrace bool

(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.
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 Changes to this property will trigger replacement. String
The OCID of the agent that this endpoint is associated with.
compartmentId String
(Updatable) The OCID of the compartment to create the endpoint in.
contentModerationConfig AgentAgentEndpointContentModerationConfig
(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.
definedTags 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.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags 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"}
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.
sessionConfig AgentAgentEndpointSessionConfig

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

shouldEnableCitation Boolean
(Updatable) Whether to show citations in the chat result.
shouldEnableSession Changes to this property will trigger replacement. Boolean
Whether or not to enable Session-based chat.
shouldEnableTrace Boolean

(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.
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 Changes to this property will trigger replacement. string
The OCID of the agent that this endpoint is associated with.
compartmentId string
(Updatable) The OCID of the compartment to create the endpoint in.
contentModerationConfig AgentAgentEndpointContentModerationConfig
(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.
definedTags {[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.
displayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags {[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"}
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.
sessionConfig AgentAgentEndpointSessionConfig

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

shouldEnableCitation boolean
(Updatable) Whether to show citations in the chat result.
shouldEnableSession Changes to this property will trigger replacement. boolean
Whether or not to enable Session-based chat.
shouldEnableTrace boolean

(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.
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 Changes to this property will trigger replacement. 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_config generativeai.AgentAgentEndpointContentModerationConfigArgs
(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.
defined_tags 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.
freeform_tags 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 generativeai.AgentAgentEndpointSessionConfigArgs

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

should_enable_citation bool
(Updatable) Whether to show citations in the chat result.
should_enable_session Changes to this property will trigger replacement. bool
Whether or not to enable Session-based chat.
should_enable_trace bool

(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.
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 Changes to this property will trigger replacement. String
The OCID of the agent that this endpoint is associated with.
compartmentId String
(Updatable) The OCID of the compartment to create the endpoint in.
contentModerationConfig Property Map
(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.
definedTags 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.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags 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"}
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.
sessionConfig Property Map

(Updatable) SessionConfig

Session Configuration on AgentEndpoint.

shouldEnableCitation Boolean
(Updatable) Whether to show citations in the chat result.
shouldEnableSession Changes to this property will trigger replacement. Boolean
Whether or not to enable Session-based chat.
shouldEnableTrace Boolean

(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.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the AgentEndpoint was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the endpoint was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Supporting Types

AgentAgentEndpointContentModerationConfig
, AgentAgentEndpointContentModerationConfigArgs

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

AgentAgentEndpointSessionConfig
, AgentAgentEndpointSessionConfigArgs

IdleTimeoutInSeconds int
(Updatable) The session will become inactive after this timeout.
IdleTimeoutInSeconds int
(Updatable) The session will become inactive after this timeout.
idleTimeoutInSeconds Integer
(Updatable) The session will become inactive after this timeout.
idleTimeoutInSeconds number
(Updatable) The session will become inactive after this timeout.
idle_timeout_in_seconds int
(Updatable) The session will become inactive after this timeout.
idleTimeoutInSeconds Number
(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"
Copy

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 oci Terraform Provider.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci