Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.GenerativeAi.AgentAgent
Explore with Pulumi AI
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,
});
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)
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
})
}
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,
});
});
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());
}
}
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}
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 string
- The unique name of the resource.
- args AgentAgentArgs
- 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 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 string
- The unique name of the resource.
- args AgentAgentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentAgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
const agentAgentResource = new oci.generativeai.AgentAgent("agentAgentResource", {
compartmentId: "string",
definedTags: {
string: "string",
},
description: "string",
displayName: "string",
freeformTags: {
string: "string",
},
knowledgeBaseIds: ["string"],
welcomeMessage: "string",
});
type: oci:GenerativeAi:AgentAgent
properties:
compartmentId: string
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
knowledgeBaseIds:
- string
welcomeMessage: string
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:
- Compartment
Id string - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - Knowledge
Base List<string>Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- Welcome
Message 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 string - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - Knowledge
Base []stringIds - (Updatable) List of OCID of the knowledgeBases associated with agent.
- Welcome
Message 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 String - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - knowledge
Base List<String>Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- welcome
Message 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 string - (Updatable) The OCID of the compartment to create the agent in.
- {[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.
- 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"} - knowledge
Base string[]Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- welcome
Message 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.
- 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.
- 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_ Sequence[str]ids - (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
- compartment
Id String - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - knowledge
Base List<String>Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- welcome
Message 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.
- Lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated 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.
- Lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated 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.
- lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated 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.
- lifecycle
Details 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.
- {[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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated 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.
- 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.
- lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated 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) -> AgentAgentfunc 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
- 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.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - Knowledge
Base List<string>Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- Lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Welcome
Message 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 string - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - Knowledge
Base []stringIds - (Updatable) List of OCID of the knowledgeBases associated with agent.
- Lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Welcome
Message 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 String - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - knowledge
Base List<String>Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - welcome
Message 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 string - (Updatable) The OCID of the compartment to create the agent in.
- {[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.
- 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"} - knowledge
Base string[]Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details 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.
- {[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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - welcome
Message 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.
- 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.
- 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_ Sequence[str]ids - (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.
- 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
- compartment
Id String - (Updatable) The OCID of the compartment to create the agent in.
- 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.
- 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"} - knowledge
Base List<String>Ids - (Updatable) List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details 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.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - welcome
Message 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"
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.