Docs Home
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
oci.GenerativeAi.AgentTool
Explore with Pulumi AI
This resource provides the Tool resource in Oracle Cloud Infrastructure Generative Ai Agent service.
Creates a tool.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testTool = new oci.generativeai.AgentTool("test_tool", {
agentId: testAgent.id,
compartmentId: compartmentId,
description: toolDescription,
toolConfig: {
toolConfigType: toolToolConfigToolConfigType,
agentEndpointId: testAgentEndpoint.id,
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,
},
httpEndpointAuthConfig: {
httpEndpointAuthSources: [{
httpEndpointAuthScope: toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScope,
httpEndpointAuthScopeConfig: {
httpEndpointAuthScopeConfigType: toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigHttpEndpointAuthScopeConfigType,
clientId: testClient.id,
idcsUrl: toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigIdcsUrl,
keyLocation: toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigKeyLocation,
keyName: testKey.name,
scopeUrl: toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigScopeUrl,
vaultSecretId: testSecret.id,
},
}],
},
iclExamples: {
inputLocationType: toolToolConfigIclExamplesInputLocationType,
bucket: toolToolConfigIclExamplesBucket,
content: toolToolConfigIclExamplesContent,
namespace: toolToolConfigIclExamplesNamespace,
prefix: toolToolConfigIclExamplesPrefix,
},
knowledgeBaseConfigs: [{
knowledgeBaseId: testKnowledgeBase.id,
}],
modelSize: toolToolConfigModelSize,
shouldEnableSelfCorrection: toolToolConfigShouldEnableSelfCorrection,
shouldEnableSqlExecution: toolToolConfigShouldEnableSqlExecution,
subnetId: testSubnet.id,
tableAndColumnDescription: {
inputLocationType: toolToolConfigTableAndColumnDescriptionInputLocationType,
bucket: toolToolConfigTableAndColumnDescriptionBucket,
content: toolToolConfigTableAndColumnDescriptionContent,
namespace: toolToolConfigTableAndColumnDescriptionNamespace,
prefix: toolToolConfigTableAndColumnDescriptionPrefix,
},
},
definedTags: {
"Operations.CostCenter": "42",
},
displayName: toolDisplayName,
freeformTags: {
Department: "Finance",
},
metadata: toolMetadata,
});
import pulumi
import pulumi_oci as oci
test_tool = oci.generativeai.AgentTool("test_tool",
agent_id=test_agent["id"],
compartment_id=compartment_id,
description=tool_description,
tool_config={
"tool_config_type": tool_tool_config_tool_config_type,
"agent_endpoint_id": test_agent_endpoint["id"],
"api_schema": {
"api_schema_input_location_type": tool_tool_config_api_schema_api_schema_input_location_type,
"bucket": tool_tool_config_api_schema_bucket,
"content": tool_tool_config_api_schema_content,
"namespace": tool_tool_config_api_schema_namespace,
"object": tool_tool_config_api_schema_object,
},
"database_connection": {
"connection_id": test_connection["id"],
"connection_type": tool_tool_config_database_connection_connection_type,
},
"database_schema": {
"input_location_type": tool_tool_config_database_schema_input_location_type,
"bucket": tool_tool_config_database_schema_bucket,
"content": tool_tool_config_database_schema_content,
"namespace": tool_tool_config_database_schema_namespace,
"prefix": tool_tool_config_database_schema_prefix,
},
"dialect": tool_tool_config_dialect,
"function": {
"description": tool_tool_config_function_description,
"name": tool_tool_config_function_name,
"parameters": tool_tool_config_function_parameters,
},
"generation_llm_customization": {
"instruction": tool_tool_config_generation_llm_customization_instruction,
},
"http_endpoint_auth_config": {
"http_endpoint_auth_sources": [{
"http_endpoint_auth_scope": tool_tool_config_http_endpoint_auth_config_http_endpoint_auth_sources_http_endpoint_auth_scope,
"http_endpoint_auth_scope_config": {
"http_endpoint_auth_scope_config_type": tool_tool_config_http_endpoint_auth_config_http_endpoint_auth_sources_http_endpoint_auth_scope_config_http_endpoint_auth_scope_config_type,
"client_id": test_client["id"],
"idcs_url": tool_tool_config_http_endpoint_auth_config_http_endpoint_auth_sources_http_endpoint_auth_scope_config_idcs_url,
"key_location": tool_tool_config_http_endpoint_auth_config_http_endpoint_auth_sources_http_endpoint_auth_scope_config_key_location,
"key_name": test_key["name"],
"scope_url": tool_tool_config_http_endpoint_auth_config_http_endpoint_auth_sources_http_endpoint_auth_scope_config_scope_url,
"vault_secret_id": test_secret["id"],
},
}],
},
"icl_examples": {
"input_location_type": tool_tool_config_icl_examples_input_location_type,
"bucket": tool_tool_config_icl_examples_bucket,
"content": tool_tool_config_icl_examples_content,
"namespace": tool_tool_config_icl_examples_namespace,
"prefix": tool_tool_config_icl_examples_prefix,
},
"knowledge_base_configs": [{
"knowledge_base_id": test_knowledge_base["id"],
}],
"model_size": tool_tool_config_model_size,
"should_enable_self_correction": tool_tool_config_should_enable_self_correction,
"should_enable_sql_execution": tool_tool_config_should_enable_sql_execution,
"subnet_id": test_subnet["id"],
"table_and_column_description": {
"input_location_type": tool_tool_config_table_and_column_description_input_location_type,
"bucket": tool_tool_config_table_and_column_description_bucket,
"content": tool_tool_config_table_and_column_description_content,
"namespace": tool_tool_config_table_and_column_description_namespace,
"prefix": tool_tool_config_table_and_column_description_prefix,
},
},
defined_tags={
"Operations.CostCenter": "42",
},
display_name=tool_display_name,
freeform_tags={
"Department": "Finance",
},
metadata=tool_metadata)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/generativeai"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := generativeai.NewAgentTool(ctx, "test_tool", &generativeai.AgentToolArgs{
AgentId: pulumi.Any(testAgent.Id),
CompartmentId: pulumi.Any(compartmentId),
Description: pulumi.Any(toolDescription),
ToolConfig: &generativeai.AgentToolToolConfigArgs{
ToolConfigType: pulumi.Any(toolToolConfigToolConfigType),
AgentEndpointId: pulumi.Any(testAgentEndpoint.Id),
ApiSchema: &generativeai.AgentToolToolConfigApiSchemaArgs{
ApiSchemaInputLocationType: pulumi.Any(toolToolConfigApiSchemaApiSchemaInputLocationType),
Bucket: pulumi.Any(toolToolConfigApiSchemaBucket),
Content: pulumi.Any(toolToolConfigApiSchemaContent),
Namespace: pulumi.Any(toolToolConfigApiSchemaNamespace),
Object: pulumi.Any(toolToolConfigApiSchemaObject),
},
DatabaseConnection: &generativeai.AgentToolToolConfigDatabaseConnectionArgs{
ConnectionId: pulumi.Any(testConnection.Id),
ConnectionType: pulumi.Any(toolToolConfigDatabaseConnectionConnectionType),
},
DatabaseSchema: &generativeai.AgentToolToolConfigDatabaseSchemaArgs{
InputLocationType: pulumi.Any(toolToolConfigDatabaseSchemaInputLocationType),
Bucket: pulumi.Any(toolToolConfigDatabaseSchemaBucket),
Content: pulumi.Any(toolToolConfigDatabaseSchemaContent),
Namespace: pulumi.Any(toolToolConfigDatabaseSchemaNamespace),
Prefix: pulumi.Any(toolToolConfigDatabaseSchemaPrefix),
},
Dialect: pulumi.Any(toolToolConfigDialect),
Function: &generativeai.AgentToolToolConfigFunctionArgs{
Description: pulumi.Any(toolToolConfigFunctionDescription),
Name: pulumi.Any(toolToolConfigFunctionName),
Parameters: pulumi.Any(toolToolConfigFunctionParameters),
},
GenerationLlmCustomization: &generativeai.AgentToolToolConfigGenerationLlmCustomizationArgs{
Instruction: pulumi.Any(toolToolConfigGenerationLlmCustomizationInstruction),
},
HttpEndpointAuthConfig: &generativeai.AgentToolToolConfigHttpEndpointAuthConfigArgs{
HttpEndpointAuthSources: generativeai.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArray{
&generativeai.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs{
HttpEndpointAuthScope: pulumi.Any(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScope),
HttpEndpointAuthScopeConfig: &generativeai.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs{
HttpEndpointAuthScopeConfigType: pulumi.Any(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigHttpEndpointAuthScopeConfigType),
ClientId: pulumi.Any(testClient.Id),
IdcsUrl: pulumi.Any(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigIdcsUrl),
KeyLocation: pulumi.Any(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigKeyLocation),
KeyName: pulumi.Any(testKey.Name),
ScopeUrl: pulumi.Any(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigScopeUrl),
VaultSecretId: pulumi.Any(testSecret.Id),
},
},
},
},
IclExamples: &generativeai.AgentToolToolConfigIclExamplesArgs{
InputLocationType: pulumi.Any(toolToolConfigIclExamplesInputLocationType),
Bucket: pulumi.Any(toolToolConfigIclExamplesBucket),
Content: pulumi.Any(toolToolConfigIclExamplesContent),
Namespace: pulumi.Any(toolToolConfigIclExamplesNamespace),
Prefix: pulumi.Any(toolToolConfigIclExamplesPrefix),
},
KnowledgeBaseConfigs: generativeai.AgentToolToolConfigKnowledgeBaseConfigArray{
&generativeai.AgentToolToolConfigKnowledgeBaseConfigArgs{
KnowledgeBaseId: pulumi.Any(testKnowledgeBase.Id),
},
},
ModelSize: pulumi.Any(toolToolConfigModelSize),
ShouldEnableSelfCorrection: pulumi.Any(toolToolConfigShouldEnableSelfCorrection),
ShouldEnableSqlExecution: pulumi.Any(toolToolConfigShouldEnableSqlExecution),
SubnetId: pulumi.Any(testSubnet.Id),
TableAndColumnDescription: &generativeai.AgentToolToolConfigTableAndColumnDescriptionArgs{
InputLocationType: pulumi.Any(toolToolConfigTableAndColumnDescriptionInputLocationType),
Bucket: pulumi.Any(toolToolConfigTableAndColumnDescriptionBucket),
Content: pulumi.Any(toolToolConfigTableAndColumnDescriptionContent),
Namespace: pulumi.Any(toolToolConfigTableAndColumnDescriptionNamespace),
Prefix: pulumi.Any(toolToolConfigTableAndColumnDescriptionPrefix),
},
},
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
DisplayName: pulumi.Any(toolDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
Metadata: pulumi.Any(toolMetadata),
})
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 testTool = new Oci.GenerativeAi.AgentTool("test_tool", new()
{
AgentId = testAgent.Id,
CompartmentId = compartmentId,
Description = toolDescription,
ToolConfig = new Oci.GenerativeAi.Inputs.AgentToolToolConfigArgs
{
ToolConfigType = toolToolConfigToolConfigType,
AgentEndpointId = testAgentEndpoint.Id,
ApiSchema = new Oci.GenerativeAi.Inputs.AgentToolToolConfigApiSchemaArgs
{
ApiSchemaInputLocationType = toolToolConfigApiSchemaApiSchemaInputLocationType,
Bucket = toolToolConfigApiSchemaBucket,
Content = toolToolConfigApiSchemaContent,
Namespace = toolToolConfigApiSchemaNamespace,
Object = toolToolConfigApiSchemaObject,
},
DatabaseConnection = new Oci.GenerativeAi.Inputs.AgentToolToolConfigDatabaseConnectionArgs
{
ConnectionId = testConnection.Id,
ConnectionType = toolToolConfigDatabaseConnectionConnectionType,
},
DatabaseSchema = new Oci.GenerativeAi.Inputs.AgentToolToolConfigDatabaseSchemaArgs
{
InputLocationType = toolToolConfigDatabaseSchemaInputLocationType,
Bucket = toolToolConfigDatabaseSchemaBucket,
Content = toolToolConfigDatabaseSchemaContent,
Namespace = toolToolConfigDatabaseSchemaNamespace,
Prefix = toolToolConfigDatabaseSchemaPrefix,
},
Dialect = toolToolConfigDialect,
Function = new Oci.GenerativeAi.Inputs.AgentToolToolConfigFunctionArgs
{
Description = toolToolConfigFunctionDescription,
Name = toolToolConfigFunctionName,
Parameters = toolToolConfigFunctionParameters,
},
GenerationLlmCustomization = new Oci.GenerativeAi.Inputs.AgentToolToolConfigGenerationLlmCustomizationArgs
{
Instruction = toolToolConfigGenerationLlmCustomizationInstruction,
},
HttpEndpointAuthConfig = new Oci.GenerativeAi.Inputs.AgentToolToolConfigHttpEndpointAuthConfigArgs
{
HttpEndpointAuthSources = new[]
{
new Oci.GenerativeAi.Inputs.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs
{
HttpEndpointAuthScope = toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScope,
HttpEndpointAuthScopeConfig = new Oci.GenerativeAi.Inputs.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs
{
HttpEndpointAuthScopeConfigType = toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigHttpEndpointAuthScopeConfigType,
ClientId = testClient.Id,
IdcsUrl = toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigIdcsUrl,
KeyLocation = toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigKeyLocation,
KeyName = testKey.Name,
ScopeUrl = toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigScopeUrl,
VaultSecretId = testSecret.Id,
},
},
},
},
IclExamples = new Oci.GenerativeAi.Inputs.AgentToolToolConfigIclExamplesArgs
{
InputLocationType = toolToolConfigIclExamplesInputLocationType,
Bucket = toolToolConfigIclExamplesBucket,
Content = toolToolConfigIclExamplesContent,
Namespace = toolToolConfigIclExamplesNamespace,
Prefix = toolToolConfigIclExamplesPrefix,
},
KnowledgeBaseConfigs = new[]
{
new Oci.GenerativeAi.Inputs.AgentToolToolConfigKnowledgeBaseConfigArgs
{
KnowledgeBaseId = testKnowledgeBase.Id,
},
},
ModelSize = toolToolConfigModelSize,
ShouldEnableSelfCorrection = toolToolConfigShouldEnableSelfCorrection,
ShouldEnableSqlExecution = toolToolConfigShouldEnableSqlExecution,
SubnetId = testSubnet.Id,
TableAndColumnDescription = new Oci.GenerativeAi.Inputs.AgentToolToolConfigTableAndColumnDescriptionArgs
{
InputLocationType = toolToolConfigTableAndColumnDescriptionInputLocationType,
Bucket = toolToolConfigTableAndColumnDescriptionBucket,
Content = toolToolConfigTableAndColumnDescriptionContent,
Namespace = toolToolConfigTableAndColumnDescriptionNamespace,
Prefix = toolToolConfigTableAndColumnDescriptionPrefix,
},
},
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = toolDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
Metadata = toolMetadata,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.AgentTool;
import com.pulumi.oci.GenerativeAi.AgentToolArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigApiSchemaArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigDatabaseConnectionArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigDatabaseSchemaArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigFunctionArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigGenerationLlmCustomizationArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigHttpEndpointAuthConfigArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigIclExamplesArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentToolToolConfigTableAndColumnDescriptionArgs;
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 testTool = new AgentTool("testTool", AgentToolArgs.builder()
.agentId(testAgent.id())
.compartmentId(compartmentId)
.description(toolDescription)
.toolConfig(AgentToolToolConfigArgs.builder()
.toolConfigType(toolToolConfigToolConfigType)
.agentEndpointId(testAgentEndpoint.id())
.apiSchema(AgentToolToolConfigApiSchemaArgs.builder()
.apiSchemaInputLocationType(toolToolConfigApiSchemaApiSchemaInputLocationType)
.bucket(toolToolConfigApiSchemaBucket)
.content(toolToolConfigApiSchemaContent)
.namespace(toolToolConfigApiSchemaNamespace)
.object(toolToolConfigApiSchemaObject)
.build())
.databaseConnection(AgentToolToolConfigDatabaseConnectionArgs.builder()
.connectionId(testConnection.id())
.connectionType(toolToolConfigDatabaseConnectionConnectionType)
.build())
.databaseSchema(AgentToolToolConfigDatabaseSchemaArgs.builder()
.inputLocationType(toolToolConfigDatabaseSchemaInputLocationType)
.bucket(toolToolConfigDatabaseSchemaBucket)
.content(toolToolConfigDatabaseSchemaContent)
.namespace(toolToolConfigDatabaseSchemaNamespace)
.prefix(toolToolConfigDatabaseSchemaPrefix)
.build())
.dialect(toolToolConfigDialect)
.function(AgentToolToolConfigFunctionArgs.builder()
.description(toolToolConfigFunctionDescription)
.name(toolToolConfigFunctionName)
.parameters(toolToolConfigFunctionParameters)
.build())
.generationLlmCustomization(AgentToolToolConfigGenerationLlmCustomizationArgs.builder()
.instruction(toolToolConfigGenerationLlmCustomizationInstruction)
.build())
.httpEndpointAuthConfig(AgentToolToolConfigHttpEndpointAuthConfigArgs.builder()
.httpEndpointAuthSources(AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs.builder()
.httpEndpointAuthScope(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScope)
.httpEndpointAuthScopeConfig(AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs.builder()
.httpEndpointAuthScopeConfigType(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigHttpEndpointAuthScopeConfigType)
.clientId(testClient.id())
.idcsUrl(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigIdcsUrl)
.keyLocation(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigKeyLocation)
.keyName(testKey.name())
.scopeUrl(toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigScopeUrl)
.vaultSecretId(testSecret.id())
.build())
.build())
.build())
.iclExamples(AgentToolToolConfigIclExamplesArgs.builder()
.inputLocationType(toolToolConfigIclExamplesInputLocationType)
.bucket(toolToolConfigIclExamplesBucket)
.content(toolToolConfigIclExamplesContent)
.namespace(toolToolConfigIclExamplesNamespace)
.prefix(toolToolConfigIclExamplesPrefix)
.build())
.knowledgeBaseConfigs(AgentToolToolConfigKnowledgeBaseConfigArgs.builder()
.knowledgeBaseId(testKnowledgeBase.id())
.build())
.modelSize(toolToolConfigModelSize)
.shouldEnableSelfCorrection(toolToolConfigShouldEnableSelfCorrection)
.shouldEnableSqlExecution(toolToolConfigShouldEnableSqlExecution)
.subnetId(testSubnet.id())
.tableAndColumnDescription(AgentToolToolConfigTableAndColumnDescriptionArgs.builder()
.inputLocationType(toolToolConfigTableAndColumnDescriptionInputLocationType)
.bucket(toolToolConfigTableAndColumnDescriptionBucket)
.content(toolToolConfigTableAndColumnDescriptionContent)
.namespace(toolToolConfigTableAndColumnDescriptionNamespace)
.prefix(toolToolConfigTableAndColumnDescriptionPrefix)
.build())
.build())
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(toolDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.metadata(toolMetadata)
.build());
}
}
resources:
testTool:
type: oci:GenerativeAi:AgentTool
name: test_tool
properties:
agentId: ${testAgent.id}
compartmentId: ${compartmentId}
description: ${toolDescription}
toolConfig:
toolConfigType: ${toolToolConfigToolConfigType}
agentEndpointId: ${testAgentEndpoint.id}
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}
httpEndpointAuthConfig:
httpEndpointAuthSources:
- httpEndpointAuthScope: ${toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScope}
httpEndpointAuthScopeConfig:
httpEndpointAuthScopeConfigType: ${toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigHttpEndpointAuthScopeConfigType}
clientId: ${testClient.id}
idcsUrl: ${toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigIdcsUrl}
keyLocation: ${toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigKeyLocation}
keyName: ${testKey.name}
scopeUrl: ${toolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourcesHttpEndpointAuthScopeConfigScopeUrl}
vaultSecretId: ${testSecret.id}
iclExamples:
inputLocationType: ${toolToolConfigIclExamplesInputLocationType}
bucket: ${toolToolConfigIclExamplesBucket}
content: ${toolToolConfigIclExamplesContent}
namespace: ${toolToolConfigIclExamplesNamespace}
prefix: ${toolToolConfigIclExamplesPrefix}
knowledgeBaseConfigs:
- knowledgeBaseId: ${testKnowledgeBase.id}
modelSize: ${toolToolConfigModelSize}
shouldEnableSelfCorrection: ${toolToolConfigShouldEnableSelfCorrection}
shouldEnableSqlExecution: ${toolToolConfigShouldEnableSqlExecution}
subnetId: ${testSubnet.id}
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",
IclExamples = new Oci.GenerativeAi.Inputs.AgentToolToolConfigIclExamplesArgs
{
InputLocationType = "string",
Bucket = "string",
Content = "string",
Namespace = "string",
Prefix = "string",
},
ShouldEnableSelfCorrection = false,
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",
},
DatabaseConnection = new Oci.GenerativeAi.Inputs.AgentToolToolConfigDatabaseConnectionArgs
{
ConnectionId = "string",
ConnectionType = "string",
},
KnowledgeBaseConfigs = new[]
{
new Oci.GenerativeAi.Inputs.AgentToolToolConfigKnowledgeBaseConfigArgs
{
KnowledgeBaseId = "string",
},
},
HttpEndpointAuthConfig = new Oci.GenerativeAi.Inputs.AgentToolToolConfigHttpEndpointAuthConfigArgs
{
HttpEndpointAuthSources = new[]
{
new Oci.GenerativeAi.Inputs.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs
{
HttpEndpointAuthScope = "string",
HttpEndpointAuthScopeConfig = new Oci.GenerativeAi.Inputs.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs
{
HttpEndpointAuthScopeConfigType = "string",
ClientId = "string",
IdcsUrl = "string",
KeyLocation = "string",
KeyName = "string",
ScopeUrl = "string",
VaultSecretId = "string",
},
},
},
},
ModelSize = "string",
AgentEndpointId = "string",
ShouldEnableSqlExecution = false,
SubnetId = "string",
TableAndColumnDescription = new Oci.GenerativeAi.Inputs.AgentToolToolConfigTableAndColumnDescriptionArgs
{
InputLocationType = "string",
Bucket = "string",
Content = "string",
Namespace = "string",
Prefix = "string",
},
ApiSchema = new Oci.GenerativeAi.Inputs.AgentToolToolConfigApiSchemaArgs
{
ApiSchemaInputLocationType = "string",
Bucket = "string",
Content = "string",
Namespace = "string",
Object = "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"),
IclExamples: &generativeai.AgentToolToolConfigIclExamplesArgs{
InputLocationType: pulumi.String("string"),
Bucket: pulumi.String("string"),
Content: pulumi.String("string"),
Namespace: pulumi.String("string"),
Prefix: pulumi.String("string"),
},
ShouldEnableSelfCorrection: pulumi.Bool(false),
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"),
},
DatabaseConnection: &generativeai.AgentToolToolConfigDatabaseConnectionArgs{
ConnectionId: pulumi.String("string"),
ConnectionType: pulumi.String("string"),
},
KnowledgeBaseConfigs: generativeai.AgentToolToolConfigKnowledgeBaseConfigArray{
&generativeai.AgentToolToolConfigKnowledgeBaseConfigArgs{
KnowledgeBaseId: pulumi.String("string"),
},
},
HttpEndpointAuthConfig: &generativeai.AgentToolToolConfigHttpEndpointAuthConfigArgs{
HttpEndpointAuthSources: generativeai.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArray{
&generativeai.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs{
HttpEndpointAuthScope: pulumi.String("string"),
HttpEndpointAuthScopeConfig: &generativeai.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs{
HttpEndpointAuthScopeConfigType: pulumi.String("string"),
ClientId: pulumi.String("string"),
IdcsUrl: pulumi.String("string"),
KeyLocation: pulumi.String("string"),
KeyName: pulumi.String("string"),
ScopeUrl: pulumi.String("string"),
VaultSecretId: pulumi.String("string"),
},
},
},
},
ModelSize: pulumi.String("string"),
AgentEndpointId: pulumi.String("string"),
ShouldEnableSqlExecution: pulumi.Bool(false),
SubnetId: pulumi.String("string"),
TableAndColumnDescription: &generativeai.AgentToolToolConfigTableAndColumnDescriptionArgs{
InputLocationType: pulumi.String("string"),
Bucket: pulumi.String("string"),
Content: pulumi.String("string"),
Namespace: pulumi.String("string"),
Prefix: pulumi.String("string"),
},
ApiSchema: &generativeai.AgentToolToolConfigApiSchemaArgs{
ApiSchemaInputLocationType: pulumi.String("string"),
Bucket: pulumi.String("string"),
Content: pulumi.String("string"),
Namespace: pulumi.String("string"),
Object: 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")
.iclExamples(AgentToolToolConfigIclExamplesArgs.builder()
.inputLocationType("string")
.bucket("string")
.content("string")
.namespace("string")
.prefix("string")
.build())
.shouldEnableSelfCorrection(false)
.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())
.databaseConnection(AgentToolToolConfigDatabaseConnectionArgs.builder()
.connectionId("string")
.connectionType("string")
.build())
.knowledgeBaseConfigs(AgentToolToolConfigKnowledgeBaseConfigArgs.builder()
.knowledgeBaseId("string")
.build())
.httpEndpointAuthConfig(AgentToolToolConfigHttpEndpointAuthConfigArgs.builder()
.httpEndpointAuthSources(AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs.builder()
.httpEndpointAuthScope("string")
.httpEndpointAuthScopeConfig(AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs.builder()
.httpEndpointAuthScopeConfigType("string")
.clientId("string")
.idcsUrl("string")
.keyLocation("string")
.keyName("string")
.scopeUrl("string")
.vaultSecretId("string")
.build())
.build())
.build())
.modelSize("string")
.agentEndpointId("string")
.shouldEnableSqlExecution(false)
.subnetId("string")
.tableAndColumnDescription(AgentToolToolConfigTableAndColumnDescriptionArgs.builder()
.inputLocationType("string")
.bucket("string")
.content("string")
.namespace("string")
.prefix("string")
.build())
.apiSchema(AgentToolToolConfigApiSchemaArgs.builder()
.apiSchemaInputLocationType("string")
.bucket("string")
.content("string")
.namespace("string")
.object("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",
"icl_examples": {
"input_location_type": "string",
"bucket": "string",
"content": "string",
"namespace": "string",
"prefix": "string",
},
"should_enable_self_correction": False,
"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",
},
"database_connection": {
"connection_id": "string",
"connection_type": "string",
},
"knowledge_base_configs": [{
"knowledge_base_id": "string",
}],
"http_endpoint_auth_config": {
"http_endpoint_auth_sources": [{
"http_endpoint_auth_scope": "string",
"http_endpoint_auth_scope_config": {
"http_endpoint_auth_scope_config_type": "string",
"client_id": "string",
"idcs_url": "string",
"key_location": "string",
"key_name": "string",
"scope_url": "string",
"vault_secret_id": "string",
},
}],
},
"model_size": "string",
"agent_endpoint_id": "string",
"should_enable_sql_execution": False,
"subnet_id": "string",
"table_and_column_description": {
"input_location_type": "string",
"bucket": "string",
"content": "string",
"namespace": "string",
"prefix": "string",
},
"api_schema": {
"api_schema_input_location_type": "string",
"bucket": "string",
"content": "string",
"namespace": "string",
"object": "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",
iclExamples: {
inputLocationType: "string",
bucket: "string",
content: "string",
namespace: "string",
prefix: "string",
},
shouldEnableSelfCorrection: false,
databaseSchema: {
inputLocationType: "string",
bucket: "string",
content: "string",
namespace: "string",
prefix: "string",
},
dialect: "string",
"function": {
description: "string",
name: "string",
parameters: {
string: "string",
},
},
generationLlmCustomization: {
instruction: "string",
},
databaseConnection: {
connectionId: "string",
connectionType: "string",
},
knowledgeBaseConfigs: [{
knowledgeBaseId: "string",
}],
httpEndpointAuthConfig: {
httpEndpointAuthSources: [{
httpEndpointAuthScope: "string",
httpEndpointAuthScopeConfig: {
httpEndpointAuthScopeConfigType: "string",
clientId: "string",
idcsUrl: "string",
keyLocation: "string",
keyName: "string",
scopeUrl: "string",
vaultSecretId: "string",
},
}],
},
modelSize: "string",
agentEndpointId: "string",
shouldEnableSqlExecution: false,
subnetId: "string",
tableAndColumnDescription: {
inputLocationType: "string",
bucket: "string",
content: "string",
namespace: "string",
prefix: "string",
},
apiSchema: {
apiSchemaInputLocationType: "string",
bucket: "string",
content: "string",
namespace: "string",
object: "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:
agentEndpointId: string
apiSchema:
apiSchemaInputLocationType: string
bucket: string
content: string
namespace: string
object: string
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
httpEndpointAuthConfig:
httpEndpointAuthSources:
- httpEndpointAuthScope: string
httpEndpointAuthScopeConfig:
clientId: string
httpEndpointAuthScopeConfigType: string
idcsUrl: string
keyLocation: string
keyName: string
scopeUrl: string
vaultSecretId: string
iclExamples:
bucket: string
content: string
inputLocationType: string
namespace: string
prefix: string
knowledgeBaseConfigs:
- knowledgeBaseId: string
modelSize: string
shouldEnableSelfCorrection: false
shouldEnableSqlExecution: false
subnetId: string
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:
- Agent
Id string - The OCID of the agent that this Tool is attached to.
- Compartment
Id string - The OCID of the compartment.
- Description string
- (Updatable) Description about the Tool.
- Tool
Config AgentTool Tool Config - (Updatable) The configuration and type of Tool.
- 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"} - 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"} - Metadata Dictionary<string, string>
- (Updatable) Key-value pairs to allow additional configurations.
- Agent
Id string - The OCID of the agent that this Tool is attached to.
- Compartment
Id string - The OCID of the compartment.
- Description string
- (Updatable) Description about the Tool.
- Tool
Config AgentTool Tool Config Args - (Updatable) The configuration and type of Tool.
- 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"} - 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"} - Metadata map[string]string
- (Updatable) Key-value pairs to allow additional configurations.
- agent
Id String - The OCID of the agent that this Tool is attached to.
- compartment
Id String - The OCID of the compartment.
- description String
- (Updatable) Description about the Tool.
- tool
Config AgentTool Tool Config - (Updatable) The configuration and type of Tool.
- 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"} - 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"} - metadata Map<String,String>
- (Updatable) Key-value pairs to allow additional configurations.
- agent
Id string - The OCID of the agent that this Tool is attached to.
- compartment
Id string - The OCID of the compartment.
- description string
- (Updatable) Description about the Tool.
- tool
Config AgentTool Tool Config - (Updatable) The configuration and type of Tool.
- {[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"} - 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"} - 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 AgentTool Tool Config Args - (Updatable) The configuration and type of Tool.
- 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.
- 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.
- agent
Id String - The OCID of the agent that this Tool is attached to.
- compartment
Id String - The OCID of the compartment.
- description String
- (Updatable) Description about the Tool.
- tool
Config Property Map - (Updatable) The configuration and type of Tool.
- 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"} - 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"} - 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.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated 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.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated 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.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated 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.
- {[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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated 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.
- 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.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated 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) -> AgentToolfunc 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.
- Agent
Id string - The OCID of the agent that this Tool is attached to.
- Compartment
Id string - The OCID of the compartment.
- 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.
- 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"} - Metadata Dictionary<string, string>
- (Updatable) Key-value pairs to allow additional configurations.
- State string
- The current state of the Tool.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time the Tool was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Tool
Config AgentTool Tool Config - (Updatable) The configuration and type of Tool.
- Agent
Id string - The OCID of the agent that this Tool is attached to.
- Compartment
Id string - The OCID of the compartment.
- 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.
- 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"} - Metadata map[string]string
- (Updatable) Key-value pairs to allow additional configurations.
- State string
- The current state of the Tool.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The date and time the Tool was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - Tool
Config AgentTool Tool Config Args - (Updatable) The configuration and type of Tool.
- agent
Id String - The OCID of the agent that this Tool is attached to.
- compartment
Id String - The OCID of the compartment.
- 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.
- 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"} - metadata Map<String,String>
- (Updatable) Key-value pairs to allow additional configurations.
- state String
- The current state of the Tool.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time the Tool was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - tool
Config AgentTool Tool Config - (Updatable) The configuration and type of Tool.
- agent
Id string - The OCID of the agent that this Tool is attached to.
- compartment
Id string - The OCID of the compartment.
- {[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.
- 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"} - metadata {[key: string]: string}
- (Updatable) Key-value pairs to allow additional configurations.
- state string
- The current state of the Tool.
- {[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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated string - The date and time the Tool was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - tool
Config AgentTool Tool Config - (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.
- 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.
- 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.
- 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 AgentTool Tool Config Args - (Updatable) The configuration and type of Tool.
- agent
Id String - The OCID of the agent that this Tool is attached to.
- compartment
Id String - The OCID of the compartment.
- 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.
- 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"} - metadata Map<String>
- (Updatable) Key-value pairs to allow additional configurations.
- state String
- The current state of the Tool.
- 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 Tool was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The date and time the Tool was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z - tool
Config Property Map - (Updatable) The configuration and type of Tool.
Supporting Types
AgentToolToolConfig, AgentToolToolConfigArgs
- Tool
Config stringType (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
- Agent
Endpoint stringId - (Updatable) The AgentEndpoint OCID to be used as a tool in this agent.
- Api
Schema AgentTool Tool Config Api Schema - (Updatable) The input location definition for Api schema.
- Database
Connection AgentTool Tool Config Database Connection - (Updatable) The connection type for Databases.
- Database
Schema AgentTool Tool Config Database Schema - (Updatable) The input location definition.
- Dialect string
- (Updatable) Dialect to be used for SQL generation.
- Function
Agent
Tool Tool Config Function - (Updatable) Details of Function for Function calling tool.
- Generation
Llm AgentCustomization Tool Tool Config Generation Llm Customization - (Updatable) Configuration to customize LLM.
- Http
Endpoint AgentAuth Config Tool Tool Config Http Endpoint Auth Config - (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
- Icl
Examples AgentTool Tool Config Icl Examples - (Updatable) The input location definition.
- Knowledge
Base List<AgentConfigs Tool Tool Config Knowledge Base Config> - (Updatable) The KnowledgeBase configurations that this RAG Tool uses
- Model
Size string - (Updatable) Size of the model.
- Should
Enable boolSelf Correction - (Updatable) To enable/disable self correction.
- Should
Enable boolSql Execution - (Updatable) To enable/disable SQL execution.
- Subnet
Id string - (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed.
- Table
And AgentColumn Description Tool Tool Config Table And Column Description - (Updatable) The input location definition.
- Tool
Config stringType (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
- Agent
Endpoint stringId - (Updatable) The AgentEndpoint OCID to be used as a tool in this agent.
- Api
Schema AgentTool Tool Config Api Schema - (Updatable) The input location definition for Api schema.
- Database
Connection AgentTool Tool Config Database Connection - (Updatable) The connection type for Databases.
- Database
Schema AgentTool Tool Config Database Schema - (Updatable) The input location definition.
- Dialect string
- (Updatable) Dialect to be used for SQL generation.
- Function
Agent
Tool Tool Config Function - (Updatable) Details of Function for Function calling tool.
- Generation
Llm AgentCustomization Tool Tool Config Generation Llm Customization - (Updatable) Configuration to customize LLM.
- Http
Endpoint AgentAuth Config Tool Tool Config Http Endpoint Auth Config - (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
- Icl
Examples AgentTool Tool Config Icl Examples - (Updatable) The input location definition.
- Knowledge
Base []AgentConfigs Tool Tool Config Knowledge Base Config - (Updatable) The KnowledgeBase configurations that this RAG Tool uses
- Model
Size string - (Updatable) Size of the model.
- Should
Enable boolSelf Correction - (Updatable) To enable/disable self correction.
- Should
Enable boolSql Execution - (Updatable) To enable/disable SQL execution.
- Subnet
Id string - (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed.
- Table
And AgentColumn Description Tool Tool Config Table And Column Description - (Updatable) The input location definition.
- tool
Config StringType (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
- agent
Endpoint StringId - (Updatable) The AgentEndpoint OCID to be used as a tool in this agent.
- api
Schema AgentTool Tool Config Api Schema - (Updatable) The input location definition for Api schema.
- database
Connection AgentTool Tool Config Database Connection - (Updatable) The connection type for Databases.
- database
Schema AgentTool Tool Config Database Schema - (Updatable) The input location definition.
- dialect String
- (Updatable) Dialect to be used for SQL generation.
- function
Agent
Tool Tool Config Function - (Updatable) Details of Function for Function calling tool.
- generation
Llm AgentCustomization Tool Tool Config Generation Llm Customization - (Updatable) Configuration to customize LLM.
- http
Endpoint AgentAuth Config Tool Tool Config Http Endpoint Auth Config - (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
- icl
Examples AgentTool Tool Config Icl Examples - (Updatable) The input location definition.
- knowledge
Base List<AgentConfigs Tool Tool Config Knowledge Base Config> - (Updatable) The KnowledgeBase configurations that this RAG Tool uses
- model
Size String - (Updatable) Size of the model.
- should
Enable BooleanSelf Correction - (Updatable) To enable/disable self correction.
- should
Enable BooleanSql Execution - (Updatable) To enable/disable SQL execution.
- subnet
Id String - (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed.
- table
And AgentColumn Description Tool Tool Config Table And Column Description - (Updatable) The input location definition.
- tool
Config stringType (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
- agent
Endpoint stringId - (Updatable) The AgentEndpoint OCID to be used as a tool in this agent.
- api
Schema AgentTool Tool Config Api Schema - (Updatable) The input location definition for Api schema.
- database
Connection AgentTool Tool Config Database Connection - (Updatable) The connection type for Databases.
- database
Schema AgentTool Tool Config Database Schema - (Updatable) The input location definition.
- dialect string
- (Updatable) Dialect to be used for SQL generation.
- function
Agent
Tool Tool Config Function - (Updatable) Details of Function for Function calling tool.
- generation
Llm AgentCustomization Tool Tool Config Generation Llm Customization - (Updatable) Configuration to customize LLM.
- http
Endpoint AgentAuth Config Tool Tool Config Http Endpoint Auth Config - (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
- icl
Examples AgentTool Tool Config Icl Examples - (Updatable) The input location definition.
- knowledge
Base AgentConfigs Tool Tool Config Knowledge Base Config[] - (Updatable) The KnowledgeBase configurations that this RAG Tool uses
- model
Size string - (Updatable) Size of the model.
- should
Enable booleanSelf Correction - (Updatable) To enable/disable self correction.
- should
Enable booleanSql Execution - (Updatable) To enable/disable SQL execution.
- subnet
Id string - (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed.
- table
And AgentColumn Description Tool Tool Config Table And Column Description - (Updatable) The input location definition.
- tool_
config_ strtype (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
- agent_
endpoint_ strid - (Updatable) The AgentEndpoint OCID to be used as a tool in this agent.
- api_
schema AgentTool Tool Config Api Schema - (Updatable) The input location definition for Api schema.
- database_
connection AgentTool Tool Config Database Connection - (Updatable) The connection type for Databases.
- database_
schema AgentTool Tool Config Database Schema - (Updatable) The input location definition.
- dialect str
- (Updatable) Dialect to be used for SQL generation.
- function
Agent
Tool Tool Config Function - (Updatable) Details of Function for Function calling tool.
- generation_
llm_ Agentcustomization Tool Tool Config Generation Llm Customization - (Updatable) Configuration to customize LLM.
- http_
endpoint_ Agentauth_ config Tool Tool Config Http Endpoint Auth Config - (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
- icl_
examples AgentTool Tool Config Icl Examples - (Updatable) The input location definition.
- knowledge_
base_ Sequence[Agentconfigs Tool Tool Config Knowledge Base Config] - (Updatable) The KnowledgeBase configurations that this RAG Tool uses
- model_
size str - (Updatable) Size of the model.
- should_
enable_ boolself_ correction - (Updatable) To enable/disable self correction.
- should_
enable_ boolsql_ execution - (Updatable) To enable/disable SQL execution.
- subnet_
id str - (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed.
- table_
and_ Agentcolumn_ description Tool Tool Config Table And Column Description - (Updatable) The input location definition.
- tool
Config StringType (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
- agent
Endpoint StringId - (Updatable) The AgentEndpoint OCID to be used as a tool in this agent.
- api
Schema Property Map - (Updatable) The input location definition for Api schema.
- database
Connection Property Map - (Updatable) The connection type for Databases.
- database
Schema 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.
- generation
Llm Property MapCustomization - (Updatable) Configuration to customize LLM.
- http
Endpoint Property MapAuth Config - (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
- icl
Examples Property Map - (Updatable) The input location definition.
- knowledge
Base List<Property Map>Configs - (Updatable) The KnowledgeBase configurations that this RAG Tool uses
- model
Size String - (Updatable) Size of the model.
- should
Enable BooleanSelf Correction - (Updatable) To enable/disable self correction.
- should
Enable BooleanSql Execution - (Updatable) To enable/disable SQL execution.
- subnet
Id String - (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed.
- table
And Property MapColumn Description - (Updatable) The input location definition.
AgentToolToolConfigApiSchema, AgentToolToolConfigApiSchemaArgs
- Api
Schema stringInput Location Type - (Updatable) Type of Api Schema InputLocation. The allowed values are:
INLINE: The Api schema input location is inline.OBJECT_STORAGE_LOCATION: The Api schema 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.
- Object string
- (Updatable) The location/name of object.
- Api
Schema stringInput Location Type - (Updatable) Type of Api Schema InputLocation. The allowed values are:
INLINE: The Api schema input location is inline.OBJECT_STORAGE_LOCATION: The Api schema 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.
- Object string
- (Updatable) The location/name of object.
- api
Schema StringInput Location Type - (Updatable) Type of Api Schema InputLocation. The allowed values are:
INLINE: The Api schema input location is inline.OBJECT_STORAGE_LOCATION: The Api schema 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.
- object String
- (Updatable) The location/name of object.
- api
Schema stringInput Location Type - (Updatable) Type of Api Schema InputLocation. The allowed values are:
INLINE: The Api schema input location is inline.OBJECT_STORAGE_LOCATION: The Api schema 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.
- object string
- (Updatable) The location/name of object.
- api_
schema_ strinput_ location_ type - (Updatable) Type of Api Schema InputLocation. The allowed values are:
INLINE: The Api schema input location is inline.OBJECT_STORAGE_LOCATION: The Api schema 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.
- object str
- (Updatable) The location/name of object.
- api
Schema StringInput Location Type - (Updatable) Type of Api Schema InputLocation. The allowed values are:
INLINE: The Api schema input location is inline.OBJECT_STORAGE_LOCATION: The Api schema 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.
- object String
- (Updatable) The location/name of object.
AgentToolToolConfigDatabaseConnection, AgentToolToolConfigDatabaseConnectionArgs
- Connection
Id string - (Updatable) The OCID of the Database Tools Connection.
- Connection
Type 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 string - (Updatable) The OCID of the Database Tools Connection.
- Connection
Type 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 String - (Updatable) The OCID of the Database Tools Connection.
- connection
Type 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 string - (Updatable) The OCID of the Database Tools Connection.
- connection
Type 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.
- connection
Id String - (Updatable) The OCID of the Database Tools Connection.
- connection
Type 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
- Input
Location stringType - (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 stringType - (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 StringType - (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 stringType - (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_ strtype - (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.
- input
Location StringType - (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.
AgentToolToolConfigHttpEndpointAuthConfig, AgentToolToolConfigHttpEndpointAuthConfigArgs
- Http
Endpoint List<AgentAuth Sources Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source> - (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
- Http
Endpoint []AgentAuth Sources Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source - (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
- http
Endpoint List<AgentAuth Sources Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source> - (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
- http
Endpoint AgentAuth Sources Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source[] - (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
- http_
endpoint_ Sequence[Agentauth_ sources Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source] - (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
- http
Endpoint List<Property Map>Auth Sources - (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource, AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceArgs
- Http
Endpoint stringAuth Scope - (Updatable) Specifies the level from which credentials should be resolved.
- Http
Endpoint AgentAuth Scope Config Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source Http Endpoint Auth Scope Config - (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
- Http
Endpoint stringAuth Scope - (Updatable) Specifies the level from which credentials should be resolved.
- Http
Endpoint AgentAuth Scope Config Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source Http Endpoint Auth Scope Config - (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
- http
Endpoint StringAuth Scope - (Updatable) Specifies the level from which credentials should be resolved.
- http
Endpoint AgentAuth Scope Config Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source Http Endpoint Auth Scope Config - (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
- http
Endpoint stringAuth Scope - (Updatable) Specifies the level from which credentials should be resolved.
- http
Endpoint AgentAuth Scope Config Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source Http Endpoint Auth Scope Config - (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
- http_
endpoint_ strauth_ scope - (Updatable) Specifies the level from which credentials should be resolved.
- http_
endpoint_ Agentauth_ scope_ config Tool Tool Config Http Endpoint Auth Config Http Endpoint Auth Source Http Endpoint Auth Scope Config - (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
- http
Endpoint StringAuth Scope - (Updatable) Specifies the level from which credentials should be resolved.
- http
Endpoint Property MapAuth Scope Config - (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig, AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfigArgs
- Http
Endpoint stringAuth Scope Config Type - (Updatable) The type of authentication to be applied for this HTTP Endpoint.
- Client
Id string - (Updatable) IDCS client ID.
- Idcs
Url string - (Updatable) IDCS OpenID discovery endpoint.
- Key
Location string - (Updatable) The location of the API key in the request.
- Key
Name string - (Updatable) The name of the key parameter in the location.
- Scope
Url string - (Updatable) OAuth2 scopes for token generation.
- Vault
Secret stringId - (Updatable) The OCID of the vault secret with username:password. Required when
authScopeis AGENT.
- Http
Endpoint stringAuth Scope Config Type - (Updatable) The type of authentication to be applied for this HTTP Endpoint.
- Client
Id string - (Updatable) IDCS client ID.
- Idcs
Url string - (Updatable) IDCS OpenID discovery endpoint.
- Key
Location string - (Updatable) The location of the API key in the request.
- Key
Name string - (Updatable) The name of the key parameter in the location.
- Scope
Url string - (Updatable) OAuth2 scopes for token generation.
- Vault
Secret stringId - (Updatable) The OCID of the vault secret with username:password. Required when
authScopeis AGENT.
- http
Endpoint StringAuth Scope Config Type - (Updatable) The type of authentication to be applied for this HTTP Endpoint.
- client
Id String - (Updatable) IDCS client ID.
- idcs
Url String - (Updatable) IDCS OpenID discovery endpoint.
- key
Location String - (Updatable) The location of the API key in the request.
- key
Name String - (Updatable) The name of the key parameter in the location.
- scope
Url String - (Updatable) OAuth2 scopes for token generation.
- vault
Secret StringId - (Updatable) The OCID of the vault secret with username:password. Required when
authScopeis AGENT.
- http
Endpoint stringAuth Scope Config Type - (Updatable) The type of authentication to be applied for this HTTP Endpoint.
- client
Id string - (Updatable) IDCS client ID.
- idcs
Url string - (Updatable) IDCS OpenID discovery endpoint.
- key
Location string - (Updatable) The location of the API key in the request.
- key
Name string - (Updatable) The name of the key parameter in the location.
- scope
Url string - (Updatable) OAuth2 scopes for token generation.
- vault
Secret stringId - (Updatable) The OCID of the vault secret with username:password. Required when
authScopeis AGENT.
- http_
endpoint_ strauth_ scope_ config_ type - (Updatable) The type of authentication to be applied for this HTTP Endpoint.
- client_
id str - (Updatable) IDCS client ID.
- idcs_
url str - (Updatable) IDCS OpenID discovery endpoint.
- key_
location str - (Updatable) The location of the API key in the request.
- key_
name str - (Updatable) The name of the key parameter in the location.
- scope_
url str - (Updatable) OAuth2 scopes for token generation.
- vault_
secret_ strid - (Updatable) The OCID of the vault secret with username:password. Required when
authScopeis AGENT.
- http
Endpoint StringAuth Scope Config Type - (Updatable) The type of authentication to be applied for this HTTP Endpoint.
- client
Id String - (Updatable) IDCS client ID.
- idcs
Url String - (Updatable) IDCS OpenID discovery endpoint.
- key
Location String - (Updatable) The location of the API key in the request.
- key
Name String - (Updatable) The name of the key parameter in the location.
- scope
Url String - (Updatable) OAuth2 scopes for token generation.
- vault
Secret StringId - (Updatable) The OCID of the vault secret with username:password. Required when
authScopeis AGENT.
AgentToolToolConfigIclExamples, AgentToolToolConfigIclExamplesArgs
- Input
Location stringType - (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 stringType - (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 StringType - (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 stringType - (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_ strtype - (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.
- input
Location StringType - (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
- Knowledge
Base stringId - (Updatable) The OCID of the knowledgeBase this RAG Tool uses
- Knowledge
Base stringId - (Updatable) The OCID of the knowledgeBase this RAG Tool uses
- knowledge
Base StringId - (Updatable) The OCID of the knowledgeBase this RAG Tool uses
- knowledge
Base stringId - (Updatable) The OCID of the knowledgeBase this RAG Tool uses
- knowledge_
base_ strid - (Updatable) The OCID of the knowledgeBase this RAG Tool uses
- knowledge
Base StringId - (Updatable) The OCID of the knowledgeBase this RAG Tool uses
AgentToolToolConfigTableAndColumnDescription, AgentToolToolConfigTableAndColumnDescriptionArgs
- Input
Location stringType - (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 stringType - (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 StringType - (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 stringType - (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_ strtype - (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.
- input
Location StringType - (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
ociTerraform Provider.
