Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. AgentAgent
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.AgentAgent

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Agent resource in Oracle Cloud Infrastructure Generative Ai Agent service.

CreateAgent

Creates an agent.

Example Usage

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

const testAgent = new oci.generativeai.AgentAgent("test_agent", {
    compartmentId: compartmentId,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: agentDescription,
    displayName: agentDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    knowledgeBaseIds: agentKnowledgeBaseIds,
    welcomeMessage: agentWelcomeMessage,
});
Copy
import pulumi
import pulumi_oci as oci

test_agent = oci.generative_ai.AgentAgent("test_agent",
    compartment_id=compartment_id,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=agent_description,
    display_name=agent_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    knowledge_base_ids=agent_knowledge_base_ids,
    welcome_message=agent_welcome_message)
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.NewAgentAgent(ctx, "test_agent", &generativeai.AgentAgentArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(agentDescription),
			DisplayName: pulumi.Any(agentDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			KnowledgeBaseIds: pulumi.Any(agentKnowledgeBaseIds),
			WelcomeMessage:   pulumi.Any(agentWelcomeMessage),
		})
		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 testAgent = new Oci.GenerativeAi.AgentAgent("test_agent", new()
    {
        CompartmentId = compartmentId,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = agentDescription,
        DisplayName = agentDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        KnowledgeBaseIds = agentKnowledgeBaseIds,
        WelcomeMessage = agentWelcomeMessage,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.AgentAgent;
import com.pulumi.oci.GenerativeAi.AgentAgentArgs;
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 testAgent = new AgentAgent("testAgent", AgentAgentArgs.builder()
            .compartmentId(compartmentId)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(agentDescription)
            .displayName(agentDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .knowledgeBaseIds(agentKnowledgeBaseIds)
            .welcomeMessage(agentWelcomeMessage)
            .build());

    }
}
Copy
resources:
  testAgent:
    type: oci:GenerativeAi:AgentAgent
    name: test_agent
    properties:
      compartmentId: ${compartmentId}
      definedTags:
        Operations.CostCenter: '42'
      description: ${agentDescription}
      displayName: ${agentDisplayName}
      freeformTags:
        Department: Finance
      knowledgeBaseIds: ${agentKnowledgeBaseIds}
      welcomeMessage: ${agentWelcomeMessage}
Copy

Create AgentAgent Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AgentAgent(name: string, args: AgentAgentArgs, opts?: CustomResourceOptions);
@overload
def AgentAgent(resource_name: str,
               args: AgentAgentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def AgentAgent(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               compartment_id: Optional[str] = None,
               defined_tags: Optional[Mapping[str, str]] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, str]] = None,
               knowledge_base_ids: Optional[Sequence[str]] = None,
               welcome_message: Optional[str] = None)
func NewAgentAgent(ctx *Context, name string, args AgentAgentArgs, opts ...ResourceOption) (*AgentAgent, error)
public AgentAgent(string name, AgentAgentArgs args, CustomResourceOptions? opts = null)
public AgentAgent(String name, AgentAgentArgs args)
public AgentAgent(String name, AgentAgentArgs args, CustomResourceOptions options)

type: oci:GenerativeAi:AgentAgent
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. AgentAgentArgs
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. AgentAgentArgs
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. AgentAgentArgs
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. AgentAgentArgs
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. AgentAgentArgs
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 agentAgentResource = new Oci.GenerativeAi.AgentAgent("agentAgentResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    KnowledgeBaseIds = new[]
    {
        "string",
    },
    WelcomeMessage = "string",
});
Copy
example, err := GenerativeAi.NewAgentAgent(ctx, "agentAgentResource", &GenerativeAi.AgentAgentArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KnowledgeBaseIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	WelcomeMessage: pulumi.String("string"),
})
Copy
var agentAgentResource = new AgentAgent("agentAgentResource", AgentAgentArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .knowledgeBaseIds("string")
    .welcomeMessage("string")
    .build());
Copy
agent_agent_resource = oci.generative_ai.AgentAgent("agentAgentResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    knowledge_base_ids=["string"],
    welcome_message="string")
Copy
const agentAgentResource = new oci.generativeai.AgentAgent("agentAgentResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    knowledgeBaseIds: ["string"],
    welcomeMessage: "string",
});
Copy
type: oci:GenerativeAi:AgentAgent
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    knowledgeBaseIds:
        - string
    welcomeMessage: string
Copy

AgentAgent 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 AgentAgent resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
KnowledgeBaseIds List<string>
(Updatable) List of OCID of the knowledgeBases associated with agent.
WelcomeMessage string

(Updatable) Details about purpose and responsibility of the agent

** 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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
KnowledgeBaseIds []string
(Updatable) List of OCID of the knowledgeBases associated with agent.
WelcomeMessage string

(Updatable) Details about purpose and responsibility of the agent

** 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

compartmentId This property is required. String
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledgeBaseIds List<String>
(Updatable) List of OCID of the knowledgeBases associated with agent.
welcomeMessage String

(Updatable) Details about purpose and responsibility of the agent

** 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

compartmentId This property is required. string
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledgeBaseIds string[]
(Updatable) List of OCID of the knowledgeBases associated with agent.
welcomeMessage string

(Updatable) Details about purpose and responsibility of the agent

** 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

compartment_id This property is required. str
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledge_base_ids Sequence[str]
(Updatable) List of OCID of the knowledgeBases associated with agent.
welcome_message str

(Updatable) Details about purpose and responsibility of the agent

** 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

compartmentId This property is required. String
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledgeBaseIds List<String>
(Updatable) List of OCID of the knowledgeBases associated with agent.
welcomeMessage String

(Updatable) Details about purpose and responsibility of the agent

** 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 AgentAgent 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 agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the agent 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 agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the agent 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 agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the agent 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 agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string
The date and time the agent 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 agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str
The date and time the agent 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 agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing AgentAgent Resource

Get an existing AgentAgent 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?: AgentAgentState, opts?: CustomResourceOptions): AgentAgent
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        knowledge_base_ids: Optional[Sequence[str]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        welcome_message: Optional[str] = None) -> AgentAgent
func GetAgentAgent(ctx *Context, name string, id IDInput, state *AgentAgentState, opts ...ResourceOption) (*AgentAgent, error)
public static AgentAgent Get(string name, Input<string> id, AgentAgentState? state, CustomResourceOptions? opts = null)
public static AgentAgent get(String name, Output<String> id, AgentAgentState state, CustomResourceOptions options)
resources:  _:    type: oci:GenerativeAi:AgentAgent    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:
CompartmentId string
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
KnowledgeBaseIds List<string>
(Updatable) List of OCID of the knowledgeBases associated with agent.
LifecycleDetails string
A message that describes the current state of the agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
WelcomeMessage string

(Updatable) Details about purpose and responsibility of the agent

** 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

CompartmentId string
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
KnowledgeBaseIds []string
(Updatable) List of OCID of the knowledgeBases associated with agent.
LifecycleDetails string
A message that describes the current state of the agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
WelcomeMessage string

(Updatable) Details about purpose and responsibility of the agent

** 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

compartmentId String
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledgeBaseIds List<String>
(Updatable) List of OCID of the knowledgeBases associated with agent.
lifecycleDetails String
A message that describes the current state of the agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcomeMessage String

(Updatable) Details about purpose and responsibility of the agent

** 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

compartmentId string
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledgeBaseIds string[]
(Updatable) List of OCID of the knowledgeBases associated with agent.
lifecycleDetails string
A message that describes the current state of the agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcomeMessage string

(Updatable) Details about purpose and responsibility of the agent

** 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

compartment_id str
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledge_base_ids Sequence[str]
(Updatable) List of OCID of the knowledgeBases associated with agent.
lifecycle_details str
A message that describes the current state of the agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcome_message str

(Updatable) Details about purpose and responsibility of the agent

** 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

compartmentId String
(Updatable) The OCID of the compartment to create the agent in.
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) Description about the agent.
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"}
knowledgeBaseIds List<String>
(Updatable) List of OCID of the knowledgeBases associated with agent.
lifecycleDetails String
A message that describes the current state of the agent 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 agent.
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 agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcomeMessage String

(Updatable) Details about purpose and responsibility of the agent

** 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

Import

Agents can be imported using the id, e.g.

$ pulumi import oci:GenerativeAi/agentAgent:AgentAgent test_agent "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.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci