Oracle Cloud Infrastructure v3.3.0, Jul 17 25

Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi

oci.GenerativeAi.AgentTool

Explore with Pulumi AI

Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  testTool:
    type: oci:GenerativeAi:AgentTool
    name: test_tool
    properties:
      agentId: ${testAgent.id}
      compartmentId: ${compartmentId}
      description: ${toolDescription}
      toolConfig:
        toolConfigType: ${toolToolConfigToolConfigType}
        apiSchema:
          - apiSchemaInputLocationType: ${toolToolConfigApiSchemaApiSchemaInputLocationType}
            bucket: ${toolToolConfigApiSchemaBucket}
            content: ${toolToolConfigApiSchemaContent}
            namespace: ${toolToolConfigApiSchemaNamespace}
            object: ${toolToolConfigApiSchemaObject}
        databaseConnection:
          connectionId: ${testConnection.id}
          connectionType: ${toolToolConfigDatabaseConnectionConnectionType}
        databaseSchema:
          inputLocationType: ${toolToolConfigDatabaseSchemaInputLocationType}
          bucket: ${toolToolConfigDatabaseSchemaBucket}
          content: ${toolToolConfigDatabaseSchemaContent}
          namespace: ${toolToolConfigDatabaseSchemaNamespace}
          prefix: ${toolToolConfigDatabaseSchemaPrefix}
        dialect: ${toolToolConfigDialect}
        function:
          description: ${toolToolConfigFunctionDescription}
          name: ${toolToolConfigFunctionName}
          parameters: ${toolToolConfigFunctionParameters}
        generationLlmCustomization:
          instruction: ${toolToolConfigGenerationLlmCustomizationInstruction}
        iclExamples:
          inputLocationType: ${toolToolConfigIclExamplesInputLocationType}
          bucket: ${toolToolConfigIclExamplesBucket}
          content: ${toolToolConfigIclExamplesContent}
          namespace: ${toolToolConfigIclExamplesNamespace}
          prefix: ${toolToolConfigIclExamplesPrefix}
        knowledgeBaseConfigs:
          - knowledgeBaseId: ${testKnowledgeBase.id}
        modelSize: ${toolToolConfigModelSize}
        shouldEnableSelfCorrection: ${toolToolConfigShouldEnableSelfCorrection}
        shouldEnableSqlExecution: ${toolToolConfigShouldEnableSqlExecution}
        tableAndColumnDescription:
          inputLocationType: ${toolToolConfigTableAndColumnDescriptionInputLocationType}
          bucket: ${toolToolConfigTableAndColumnDescriptionBucket}
          content: ${toolToolConfigTableAndColumnDescriptionContent}
          namespace: ${toolToolConfigTableAndColumnDescriptionNamespace}
          prefix: ${toolToolConfigTableAndColumnDescriptionPrefix}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${toolDisplayName}
      freeformTags:
        Department: Finance
      metadata: ${toolMetadata}

Create AgentTool Resource

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

Constructor syntax

new AgentTool(name: string, args: AgentToolArgs, opts?: CustomResourceOptions);

@overload
def AgentTool(resource_name: str,
              args: AgentToolArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def AgentTool(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              agent_id: Optional[str] = None,
              compartment_id: Optional[str] = None,
              description: Optional[str] = None,
              tool_config: Optional[AgentToolToolConfigArgs] = None,
              defined_tags: Optional[Mapping[str, str]] = None,
              display_name: Optional[str] = None,
              freeform_tags: Optional[Mapping[str, str]] = None,
              metadata: Optional[Mapping[str, str]] = None)

func NewAgentTool(ctx *Context, name string, args AgentToolArgs, opts ...ResourceOption) (*AgentTool, error)

public AgentTool(string name, AgentToolArgs args, CustomResourceOptions? opts = null)

public AgentTool(String name, AgentToolArgs args)
public AgentTool(String name, AgentToolArgs args, CustomResourceOptions options)

type: oci:GenerativeAi:AgentTool
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 AgentToolArgs: 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 AgentToolArgs: 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 AgentToolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AgentToolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AgentToolArgs: 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 agentToolResource = new Oci.GenerativeAi.AgentTool("agentToolResource", new()
{
    AgentId = "string",
    CompartmentId = "string",
    Description = "string",
    ToolConfig = new Oci.GenerativeAi.Inputs.AgentToolToolConfigArgs
    {
        ToolConfigType = "string",
        DatabaseConnection = new Oci.GenerativeAi.Inputs.AgentToolToolConfigDatabaseConnectionArgs
        {
            ConnectionId = "string",
            ConnectionType = "string",
        },
        DatabaseSchema = new Oci.GenerativeAi.Inputs.AgentToolToolConfigDatabaseSchemaArgs
        {
            InputLocationType = "string",
            Bucket = "string",
            Content = "string",
            Namespace = "string",
            Prefix = "string",
        },
        Dialect = "string",
        Function = new Oci.GenerativeAi.Inputs.AgentToolToolConfigFunctionArgs
        {
            Description = "string",
            Name = "string",
            Parameters = 
            {
                { "string", "string" },
            },
        },
        GenerationLlmCustomization = new Oci.GenerativeAi.Inputs.AgentToolToolConfigGenerationLlmCustomizationArgs
        {
            Instruction = "string",
        },
        IclExamples = new Oci.GenerativeAi.Inputs.AgentToolToolConfigIclExamplesArgs
        {
            InputLocationType = "string",
            Bucket = "string",
            Content = "string",
            Namespace = "string",
            Prefix = "string",
        },
        KnowledgeBaseConfigs = new[]
        {
            new Oci.GenerativeAi.Inputs.AgentToolToolConfigKnowledgeBaseConfigArgs
            {
                KnowledgeBaseId = "string",
            },
        },
        ModelSize = "string",
        ShouldEnableSelfCorrection = false,
        ShouldEnableSqlExecution = false,
        TableAndColumnDescription = new Oci.GenerativeAi.Inputs.AgentToolToolConfigTableAndColumnDescriptionArgs
        {
            InputLocationType = "string",
            Bucket = "string",
            Content = "string",
            Namespace = "string",
            Prefix = "string",
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Metadata = 
    {
        { "string", "string" },
    },
});

example, err := generativeai.NewAgentTool(ctx, "agentToolResource", &generativeai.AgentToolArgs{
	AgentId:       pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	Description:   pulumi.String("string"),
	ToolConfig: &generativeai.AgentToolToolConfigArgs{
		ToolConfigType: pulumi.String("string"),
		DatabaseConnection: &generativeai.AgentToolToolConfigDatabaseConnectionArgs{
			ConnectionId:   pulumi.String("string"),
			ConnectionType: pulumi.String("string"),
		},
		DatabaseSchema: &generativeai.AgentToolToolConfigDatabaseSchemaArgs{
			InputLocationType: pulumi.String("string"),
			Bucket:            pulumi.String("string"),
			Content:           pulumi.String("string"),
			Namespace:         pulumi.String("string"),
			Prefix:            pulumi.String("string"),
		},
		Dialect: pulumi.String("string"),
		Function: &generativeai.AgentToolToolConfigFunctionArgs{
			Description: pulumi.String("string"),
			Name:        pulumi.String("string"),
			Parameters: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		GenerationLlmCustomization: &generativeai.AgentToolToolConfigGenerationLlmCustomizationArgs{
			Instruction: pulumi.String("string"),
		},
		IclExamples: &generativeai.AgentToolToolConfigIclExamplesArgs{
			InputLocationType: pulumi.String("string"),
			Bucket:            pulumi.String("string"),
			Content:           pulumi.String("string"),
			Namespace:         pulumi.String("string"),
			Prefix:            pulumi.String("string"),
		},
		KnowledgeBaseConfigs: generativeai.AgentToolToolConfigKnowledgeBaseConfigArray{
			&generativeai.AgentToolToolConfigKnowledgeBaseConfigArgs{
				KnowledgeBaseId: pulumi.String("string"),
			},
		},
		ModelSize:                  pulumi.String("string"),
		ShouldEnableSelfCorrection: pulumi.Bool(false),
		ShouldEnableSqlExecution:   pulumi.Bool(false),
		TableAndColumnDescription: &generativeai.AgentToolToolConfigTableAndColumnDescriptionArgs{
			InputLocationType: pulumi.String("string"),
			Bucket:            pulumi.String("string"),
			Content:           pulumi.String("string"),
			Namespace:         pulumi.String("string"),
			Prefix:            pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var agentToolResource = new AgentTool("agentToolResource", AgentToolArgs.builder()
    .agentId("string")
    .compartmentId("string")
    .description("string")
    .toolConfig(AgentToolToolConfigArgs.builder()
        .toolConfigType("string")
        .databaseConnection(AgentToolToolConfigDatabaseConnectionArgs.builder()
            .connectionId("string")
            .connectionType("string")
            .build())
        .databaseSchema(AgentToolToolConfigDatabaseSchemaArgs.builder()
            .inputLocationType("string")
            .bucket("string")
            .content("string")
            .namespace("string")
            .prefix("string")
            .build())
        .dialect("string")
        .function(AgentToolToolConfigFunctionArgs.builder()
            .description("string")
            .name("string")
            .parameters(Map.of("string", "string"))
            .build())
        .generationLlmCustomization(AgentToolToolConfigGenerationLlmCustomizationArgs.builder()
            .instruction("string")
            .build())
        .iclExamples(AgentToolToolConfigIclExamplesArgs.builder()
            .inputLocationType("string")
            .bucket("string")
            .content("string")
            .namespace("string")
            .prefix("string")
            .build())
        .knowledgeBaseConfigs(AgentToolToolConfigKnowledgeBaseConfigArgs.builder()
            .knowledgeBaseId("string")
            .build())
        .modelSize("string")
        .shouldEnableSelfCorrection(false)
        .shouldEnableSqlExecution(false)
        .tableAndColumnDescription(AgentToolToolConfigTableAndColumnDescriptionArgs.builder()
            .inputLocationType("string")
            .bucket("string")
            .content("string")
            .namespace("string")
            .prefix("string")
            .build())
        .build())
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .metadata(Map.of("string", "string"))
    .build());

agent_tool_resource = oci.generativeai.AgentTool("agentToolResource",
    agent_id="string",
    compartment_id="string",
    description="string",
    tool_config={
        "tool_config_type": "string",
        "database_connection": {
            "connection_id": "string",
            "connection_type": "string",
        },
        "database_schema": {
            "input_location_type": "string",
            "bucket": "string",
            "content": "string",
            "namespace": "string",
            "prefix": "string",
        },
        "dialect": "string",
        "function": {
            "description": "string",
            "name": "string",
            "parameters": {
                "string": "string",
            },
        },
        "generation_llm_customization": {
            "instruction": "string",
        },
        "icl_examples": {
            "input_location_type": "string",
            "bucket": "string",
            "content": "string",
            "namespace": "string",
            "prefix": "string",
        },
        "knowledge_base_configs": [{
            "knowledge_base_id": "string",
        }],
        "model_size": "string",
        "should_enable_self_correction": False,
        "should_enable_sql_execution": False,
        "table_and_column_description": {
            "input_location_type": "string",
            "bucket": "string",
            "content": "string",
            "namespace": "string",
            "prefix": "string",
        },
    },
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    metadata={
        "string": "string",
    })

const agentToolResource = new oci.generativeai.AgentTool("agentToolResource", {
    agentId: "string",
    compartmentId: "string",
    description: "string",
    toolConfig: {
        toolConfigType: "string",
        databaseConnection: {
            connectionId: "string",
            connectionType: "string",
        },
        databaseSchema: {
            inputLocationType: "string",
            bucket: "string",
            content: "string",
            namespace: "string",
            prefix: "string",
        },
        dialect: "string",
        "function": {
            description: "string",
            name: "string",
            parameters: {
                string: "string",
            },
        },
        generationLlmCustomization: {
            instruction: "string",
        },
        iclExamples: {
            inputLocationType: "string",
            bucket: "string",
            content: "string",
            namespace: "string",
            prefix: "string",
        },
        knowledgeBaseConfigs: [{
            knowledgeBaseId: "string",
        }],
        modelSize: "string",
        shouldEnableSelfCorrection: false,
        shouldEnableSqlExecution: false,
        tableAndColumnDescription: {
            inputLocationType: "string",
            bucket: "string",
            content: "string",
            namespace: "string",
            prefix: "string",
        },
    },
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    metadata: {
        string: "string",
    },
});

type: oci:GenerativeAi:AgentTool
properties:
    agentId: string
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    metadata:
        string: string
    toolConfig:
        databaseConnection:
            connectionId: string
            connectionType: string
        databaseSchema:
            bucket: string
            content: string
            inputLocationType: string
            namespace: string
            prefix: string
        dialect: string
        function:
            description: string
            name: string
            parameters:
                string: string
        generationLlmCustomization:
            instruction: string
        iclExamples:
            bucket: string
            content: string
            inputLocationType: string
            namespace: string
            prefix: string
        knowledgeBaseConfigs:
            - knowledgeBaseId: string
        modelSize: string
        shouldEnableSelfCorrection: false
        shouldEnableSqlExecution: false
        tableAndColumnDescription:
            bucket: string
            content: string
            inputLocationType: string
            namespace: string
            prefix: string
        toolConfigType: string

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

AgentId string: The OCID of the agent that this Tool is attached to.
CompartmentId string: The OCID of the compartment.
Description string: (Updatable) Description about the Tool.
ToolConfig AgentToolToolConfig: (Updatable) The configuration and type of Tool.
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"}
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"}
Metadata Dictionary<string, string>: (Updatable) Key-value pairs to allow additional configurations.

AgentId string: The OCID of the agent that this Tool is attached to.
CompartmentId string: The OCID of the compartment.
Description string: (Updatable) Description about the Tool.
ToolConfig AgentToolToolConfigArgs: (Updatable) The configuration and type of Tool.
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"}
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"}
Metadata map[string]string: (Updatable) Key-value pairs to allow additional configurations.

agentId String: The OCID of the agent that this Tool is attached to.
compartmentId String: The OCID of the compartment.
description String: (Updatable) Description about the Tool.
toolConfig AgentToolToolConfig: (Updatable) The configuration and type of Tool.
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"}
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"}
metadata Map<String,String>: (Updatable) Key-value pairs to allow additional configurations.

agentId string: The OCID of the agent that this Tool is attached to.
compartmentId string: The OCID of the compartment.
description string: (Updatable) Description about the Tool.
toolConfig AgentToolToolConfig: (Updatable) The configuration and type of Tool.
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"}
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"}
metadata {[key: string]: string}: (Updatable) Key-value pairs to allow additional configurations.

agent_id str: The OCID of the agent that this Tool is attached to.
compartment_id str: The OCID of the compartment.
description str: (Updatable) Description about the Tool.
tool_config AgentToolToolConfigArgs: (Updatable) The configuration and type of Tool.
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"}
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"}
metadata Mapping[str, str]: (Updatable) Key-value pairs to allow additional configurations.

agentId String: The OCID of the agent that this Tool is attached to.
compartmentId String: The OCID of the compartment.
description String: (Updatable) Description about the Tool.
toolConfig Property Map: (Updatable) The configuration and type of Tool.
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"}
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"}
metadata Map<String>: (Updatable) Key-value pairs to allow additional configurations.

Outputs

All input properties are implicitly available as output properties. Additionally, the AgentTool resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
State string: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the Tool 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.
State string: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the Tool 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.
state String: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the Tool 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.
state string: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string: The date and time the Tool 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.
state str: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str: The date and time the Tool 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.
state String: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing AgentTool Resource

Get an existing AgentTool 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?: AgentToolState, opts?: CustomResourceOptions): AgentTool

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = 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,
        metadata: Optional[Mapping[str, str]] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        tool_config: Optional[AgentToolToolConfigArgs] = None) -> AgentTool

func GetAgentTool(ctx *Context, name string, id IDInput, state *AgentToolState, opts ...ResourceOption) (*AgentTool, error)

public static AgentTool Get(string name, Input<string> id, AgentToolState? state, CustomResourceOptions? opts = null)

public static AgentTool get(String name, Output<String> id, AgentToolState state, CustomResourceOptions options)

resources:  _:    type: oci:GenerativeAi:AgentTool    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.

The following state arguments are supported:

AgentId string: The OCID of the agent that this Tool is attached to.
CompartmentId string: The OCID of the compartment.
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 Tool.
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"}
Metadata Dictionary<string, string>: (Updatable) Key-value pairs to allow additional configurations.
State string: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
ToolConfig AgentToolToolConfig: (Updatable) The configuration and type of Tool.

AgentId string: The OCID of the agent that this Tool is attached to.
CompartmentId string: The OCID of the compartment.
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 Tool.
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"}
Metadata map[string]string: (Updatable) Key-value pairs to allow additional configurations.
State string: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
ToolConfig AgentToolToolConfigArgs: (Updatable) The configuration and type of Tool.

agentId String: The OCID of the agent that this Tool is attached to.
compartmentId String: The OCID of the compartment.
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 Tool.
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"}
metadata Map<String,String>: (Updatable) Key-value pairs to allow additional configurations.
state String: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
toolConfig AgentToolToolConfig: (Updatable) The configuration and type of Tool.

agentId string: The OCID of the agent that this Tool is attached to.
compartmentId string: The OCID of the compartment.
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 Tool.
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"}
metadata {[key: string]: string}: (Updatable) Key-value pairs to allow additional configurations.
state string: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
toolConfig AgentToolToolConfig: (Updatable) The configuration and type of Tool.

agent_id str: The OCID of the agent that this Tool is attached to.
compartment_id str: The OCID of the compartment.
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 Tool.
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"}
metadata Mapping[str, str]: (Updatable) Key-value pairs to allow additional configurations.
state str: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
tool_config AgentToolToolConfigArgs: (Updatable) The configuration and type of Tool.

agentId String: The OCID of the agent that this Tool is attached to.
compartmentId String: The OCID of the compartment.
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 Tool.
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"}
metadata Map<String>: (Updatable) Key-value pairs to allow additional configurations.
state String: The current state of the Tool.
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 Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
toolConfig Property Map: (Updatable) The configuration and type of Tool.

Supporting Types

AgentToolToolConfig, AgentToolToolConfigArgs

ToolConfigType string

(Updatable) The type of the Tool config. The allowed values are:

SQL_TOOL_CONFIG: The config for sql Tool.
RAG_TOOL_CONFIG: The config for rag Tool.
FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

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

DatabaseConnection AgentToolToolConfigDatabaseConnection

(Updatable) The connection type for Databases.

DatabaseSchema AgentToolToolConfigDatabaseSchema

(Updatable) The input location definition.

Dialect string

(Updatable) Dialect to be used for SQL generation.

Function AgentToolToolConfigFunction

(Updatable) Details of Function for Function calling tool.

GenerationLlmCustomization AgentToolToolConfigGenerationLlmCustomization

(Updatable) Configuration to customize LLM.

IclExamples AgentToolToolConfigIclExamples

(Updatable) The input location definition.

KnowledgeBaseConfigs List<AgentToolToolConfigKnowledgeBaseConfig>

(Updatable) The KnowledgeBase configurations that this RAG Tool uses

ModelSize string

(Updatable) Size of the model.

ShouldEnableSelfCorrection bool

(Updatable) To enable/disable self correction.

ShouldEnableSqlExecution bool

(Updatable) To enable/disable SQL execution.

TableAndColumnDescription AgentToolToolConfigTableAndColumnDescription

(Updatable) The input location definition.

ToolConfigType string

(Updatable) The type of the Tool config. The allowed values are:

SQL_TOOL_CONFIG: The config for sql Tool.
RAG_TOOL_CONFIG: The config for rag Tool.
FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

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

DatabaseConnection AgentToolToolConfigDatabaseConnection

(Updatable) The connection type for Databases.

DatabaseSchema AgentToolToolConfigDatabaseSchema

(Updatable) The input location definition.

Dialect string

(Updatable) Dialect to be used for SQL generation.

Function AgentToolToolConfigFunction

(Updatable) Details of Function for Function calling tool.

GenerationLlmCustomization AgentToolToolConfigGenerationLlmCustomization

(Updatable) Configuration to customize LLM.

IclExamples AgentToolToolConfigIclExamples

(Updatable) The input location definition.

KnowledgeBaseConfigs []AgentToolToolConfigKnowledgeBaseConfig

(Updatable) The KnowledgeBase configurations that this RAG Tool uses

ModelSize string

(Updatable) Size of the model.

ShouldEnableSelfCorrection bool

(Updatable) To enable/disable self correction.

ShouldEnableSqlExecution bool

(Updatable) To enable/disable SQL execution.

TableAndColumnDescription AgentToolToolConfigTableAndColumnDescription

(Updatable) The input location definition.

toolConfigType String

(Updatable) The type of the Tool config. The allowed values are:

SQL_TOOL_CONFIG: The config for sql Tool.
RAG_TOOL_CONFIG: The config for rag Tool.
FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

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

databaseConnection AgentToolToolConfigDatabaseConnection

(Updatable) The connection type for Databases.

databaseSchema AgentToolToolConfigDatabaseSchema

(Updatable) The input location definition.

dialect String

(Updatable) Dialect to be used for SQL generation.

function AgentToolToolConfigFunction

(Updatable) Details of Function for Function calling tool.

generationLlmCustomization AgentToolToolConfigGenerationLlmCustomization

(Updatable) Configuration to customize LLM.

iclExamples AgentToolToolConfigIclExamples

(Updatable) The input location definition.

knowledgeBaseConfigs List<AgentToolToolConfigKnowledgeBaseConfig>

(Updatable) The KnowledgeBase configurations that this RAG Tool uses

modelSize String

(Updatable) Size of the model.

shouldEnableSelfCorrection Boolean

(Updatable) To enable/disable self correction.

shouldEnableSqlExecution Boolean

(Updatable) To enable/disable SQL execution.

tableAndColumnDescription AgentToolToolConfigTableAndColumnDescription

(Updatable) The input location definition.

toolConfigType string

(Updatable) The type of the Tool config. The allowed values are:

SQL_TOOL_CONFIG: The config for sql Tool.
RAG_TOOL_CONFIG: The config for rag Tool.
FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

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

databaseConnection AgentToolToolConfigDatabaseConnection

(Updatable) The connection type for Databases.

databaseSchema AgentToolToolConfigDatabaseSchema

(Updatable) The input location definition.

dialect string

(Updatable) Dialect to be used for SQL generation.

function AgentToolToolConfigFunction

(Updatable) Details of Function for Function calling tool.

generationLlmCustomization AgentToolToolConfigGenerationLlmCustomization

(Updatable) Configuration to customize LLM.

iclExamples AgentToolToolConfigIclExamples

(Updatable) The input location definition.

knowledgeBaseConfigs AgentToolToolConfigKnowledgeBaseConfig[]

(Updatable) The KnowledgeBase configurations that this RAG Tool uses

modelSize string

(Updatable) Size of the model.

shouldEnableSelfCorrection boolean

(Updatable) To enable/disable self correction.

shouldEnableSqlExecution boolean

(Updatable) To enable/disable SQL execution.

tableAndColumnDescription AgentToolToolConfigTableAndColumnDescription

(Updatable) The input location definition.

tool_config_type str

(Updatable) The type of the Tool config. The allowed values are:

SQL_TOOL_CONFIG: The config for sql Tool.
RAG_TOOL_CONFIG: The config for rag Tool.
FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

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

database_connection AgentToolToolConfigDatabaseConnection

(Updatable) The connection type for Databases.

database_schema AgentToolToolConfigDatabaseSchema

(Updatable) The input location definition.

dialect str

(Updatable) Dialect to be used for SQL generation.

function AgentToolToolConfigFunction

(Updatable) Details of Function for Function calling tool.

generation_llm_customization AgentToolToolConfigGenerationLlmCustomization

(Updatable) Configuration to customize LLM.

icl_examples AgentToolToolConfigIclExamples

(Updatable) The input location definition.

knowledge_base_configs Sequence[AgentToolToolConfigKnowledgeBaseConfig]

(Updatable) The KnowledgeBase configurations that this RAG Tool uses

model_size str

(Updatable) Size of the model.

should_enable_self_correction bool

(Updatable) To enable/disable self correction.

should_enable_sql_execution bool

(Updatable) To enable/disable SQL execution.

table_and_column_description AgentToolToolConfigTableAndColumnDescription

(Updatable) The input location definition.

toolConfigType String

(Updatable) The type of the Tool config. The allowed values are:

SQL_TOOL_CONFIG: The config for sql Tool.
RAG_TOOL_CONFIG: The config for rag Tool.
FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

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

databaseConnection Property Map

(Updatable) The connection type for Databases.

databaseSchema Property Map

(Updatable) The input location definition.

dialect String

(Updatable) Dialect to be used for SQL generation.

function Property Map

(Updatable) Details of Function for Function calling tool.

generationLlmCustomization Property Map

(Updatable) Configuration to customize LLM.

iclExamples Property Map

(Updatable) The input location definition.

knowledgeBaseConfigs List<Property Map>

(Updatable) The KnowledgeBase configurations that this RAG Tool uses

modelSize String

(Updatable) Size of the model.

shouldEnableSelfCorrection Boolean

(Updatable) To enable/disable self correction.

shouldEnableSqlExecution Boolean

(Updatable) To enable/disable SQL execution.

tableAndColumnDescription Property Map

(Updatable) The input location definition.

AgentToolToolConfigDatabaseConnection, AgentToolToolConfigDatabaseConnectionArgs

ConnectionId string

(Updatable) The OCID of the Database Tools Connection.

ConnectionType string

(Updatable) The type of Database connection. The allowed values are:

DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

ConnectionId string

(Updatable) The OCID of the Database Tools Connection.

ConnectionType string

(Updatable) The type of Database connection. The allowed values are:

DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

connectionId String

(Updatable) The OCID of the Database Tools Connection.

connectionType String

(Updatable) The type of Database connection. The allowed values are:

DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

connectionId string

(Updatable) The OCID of the Database Tools Connection.

connectionType string

(Updatable) The type of Database connection. The allowed values are:

DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

connection_id str

(Updatable) The OCID of the Database Tools Connection.

connection_type str

(Updatable) The type of Database connection. The allowed values are:

DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

connectionId String

(Updatable) The OCID of the Database Tools Connection.

connectionType String

(Updatable) The type of Database connection. The allowed values are:

DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

AgentToolToolConfigDatabaseSchema, AgentToolToolConfigDatabaseSchemaArgs

InputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

Bucket string

(Updatable) The bucket name of an object.

Content string

(Updatable) Inline content as input.

Namespace string

(Updatable) The namespace name of an object.

Prefix string

(Updatable) The prefix of file object(s) or folder prefix.

InputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

Bucket string

(Updatable) The bucket name of an object.

Content string

(Updatable) Inline content as input.

Namespace string

(Updatable) The namespace name of an object.

Prefix string

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType String

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket String

(Updatable) The bucket name of an object.

content String

(Updatable) Inline content as input.

namespace String

(Updatable) The namespace name of an object.

prefix String

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket string

(Updatable) The bucket name of an object.

content string

(Updatable) Inline content as input.

namespace string

(Updatable) The namespace name of an object.

prefix string

(Updatable) The prefix of file object(s) or folder prefix.

input_location_type str

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket str

(Updatable) The bucket name of an object.

content str

(Updatable) Inline content as input.

namespace str

(Updatable) The namespace name of an object.

prefix str

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType String

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket String

(Updatable) The bucket name of an object.

content String

(Updatable) Inline content as input.

namespace String

(Updatable) The namespace name of an object.

prefix String

(Updatable) The prefix of file object(s) or folder prefix.

AgentToolToolConfigFunction, AgentToolToolConfigFunctionArgs

Description string: (Updatable) A description of the function.
Name string: (Updatable) The name of the function to invoke.
Parameters Dictionary<string, string>: (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

Description string: (Updatable) A description of the function.
Name string: (Updatable) The name of the function to invoke.
Parameters map[string]string: (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

description String: (Updatable) A description of the function.
name String: (Updatable) The name of the function to invoke.
parameters Map<String,String>: (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

description string: (Updatable) A description of the function.
name string: (Updatable) The name of the function to invoke.
parameters {[key: string]: string}: (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

description str: (Updatable) A description of the function.
name str: (Updatable) The name of the function to invoke.
parameters Mapping[str, str]: (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

description String: (Updatable) A description of the function.
name String: (Updatable) The name of the function to invoke.
parameters Map<String>: (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

AgentToolToolConfigGenerationLlmCustomization, AgentToolToolConfigGenerationLlmCustomizationArgs

Instruction string: (Updatable) If specified, the default instruction is replaced with provided instruction.

Instruction string: (Updatable) If specified, the default instruction is replaced with provided instruction.

instruction String: (Updatable) If specified, the default instruction is replaced with provided instruction.

instruction string: (Updatable) If specified, the default instruction is replaced with provided instruction.

instruction str: (Updatable) If specified, the default instruction is replaced with provided instruction.

instruction String: (Updatable) If specified, the default instruction is replaced with provided instruction.

AgentToolToolConfigIclExamples, AgentToolToolConfigIclExamplesArgs

InputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

Bucket string

(Updatable) The bucket name of an object.

Content string

(Updatable) Inline content as input.

Namespace string

(Updatable) The namespace name of an object.

Prefix string

(Updatable) The prefix of file object(s) or folder prefix.

InputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

Bucket string

(Updatable) The bucket name of an object.

Content string

(Updatable) Inline content as input.

Namespace string

(Updatable) The namespace name of an object.

Prefix string

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType String

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket String

(Updatable) The bucket name of an object.

content String

(Updatable) Inline content as input.

namespace String

(Updatable) The namespace name of an object.

prefix String

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket string

(Updatable) The bucket name of an object.

content string

(Updatable) Inline content as input.

namespace string

(Updatable) The namespace name of an object.

prefix string

(Updatable) The prefix of file object(s) or folder prefix.

input_location_type str

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket str

(Updatable) The bucket name of an object.

content str

(Updatable) Inline content as input.

namespace str

(Updatable) The namespace name of an object.

prefix str

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType String

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket String

(Updatable) The bucket name of an object.

content String

(Updatable) Inline content as input.

namespace String

(Updatable) The namespace name of an object.

prefix String

(Updatable) The prefix of file object(s) or folder prefix.

AgentToolToolConfigKnowledgeBaseConfig, AgentToolToolConfigKnowledgeBaseConfigArgs

KnowledgeBaseId string: (Updatable) The OCID of the knowledgeBase this RAG Tool uses

KnowledgeBaseId string: (Updatable) The OCID of the knowledgeBase this RAG Tool uses

knowledgeBaseId String: (Updatable) The OCID of the knowledgeBase this RAG Tool uses

knowledgeBaseId string: (Updatable) The OCID of the knowledgeBase this RAG Tool uses

knowledge_base_id str: (Updatable) The OCID of the knowledgeBase this RAG Tool uses

knowledgeBaseId String: (Updatable) The OCID of the knowledgeBase this RAG Tool uses

AgentToolToolConfigTableAndColumnDescription, AgentToolToolConfigTableAndColumnDescriptionArgs

InputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

Bucket string

(Updatable) The bucket name of an object.

Content string

(Updatable) Inline content as input.

Namespace string

(Updatable) The namespace name of an object.

Prefix string

(Updatable) The prefix of file object(s) or folder prefix.

InputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

Bucket string

(Updatable) The bucket name of an object.

Content string

(Updatable) Inline content as input.

Namespace string

(Updatable) The namespace name of an object.

Prefix string

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType String

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket String

(Updatable) The bucket name of an object.

content String

(Updatable) Inline content as input.

namespace String

(Updatable) The namespace name of an object.

prefix String

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType string

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket string

(Updatable) The bucket name of an object.

content string

(Updatable) Inline content as input.

namespace string

(Updatable) The namespace name of an object.

prefix string

(Updatable) The prefix of file object(s) or folder prefix.

input_location_type str

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket str

(Updatable) The bucket name of an object.

content str

(Updatable) Inline content as input.

namespace str

(Updatable) The namespace name of an object.

prefix str

(Updatable) The prefix of file object(s) or folder prefix.

inputLocationType String

(Updatable) Type of InputLocation. The allowed values are:

INLINE: The input location is inline.
OBJECT_STORAGE_PREFIX: The input location is object storage.

bucket String

(Updatable) The bucket name of an object.

content String

(Updatable) Inline content as input.

namespace String

(Updatable) The namespace name of an object.

prefix String

(Updatable) The prefix of file object(s) or folder prefix.

Import

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

$ pulumi import oci:GenerativeAi/agentTool:AgentTool test_tool "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 oci Terraform Provider.

Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.GenerativeAi.AgentTool

On this page

On this page

Example Usage

Create AgentTool Resource

Constructor syntax

Parameters

Constructor example

AgentTool Resource Properties

Inputs

Outputs

Look up Existing AgentTool Resource

Supporting Types

AgentToolToolConfig, AgentToolToolConfigArgs

AgentToolToolConfigDatabaseConnection, AgentToolToolConfigDatabaseConnectionArgs

AgentToolToolConfigDatabaseSchema, AgentToolToolConfigDatabaseSchemaArgs

AgentToolToolConfigFunction, AgentToolToolConfigFunctionArgs

AgentToolToolConfigGenerationLlmCustomization, AgentToolToolConfigGenerationLlmCustomizationArgs

AgentToolToolConfigIclExamples, AgentToolToolConfigIclExamplesArgs

AgentToolToolConfigKnowledgeBaseConfig, AgentToolToolConfigKnowledgeBaseConfigArgs

AgentToolToolConfigTableAndColumnDescription, AgentToolToolConfigTableAndColumnDescriptionArgs

Import

Package Details

On this page

On this page