Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
oci.GenerativeAi.getAgentTools
Explore with Pulumi AI
This data source provides the list of Tools in Oracle Cloud Infrastructure Generative Ai Agent service.
Gets a list of tools.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testTools = oci.GenerativeAi.getAgentTools({
agentId: testAgent.id,
compartmentId: compartmentId,
displayName: toolDisplayName,
state: toolState,
});
import pulumi
import pulumi_oci as oci
test_tools = oci.GenerativeAi.get_agent_tools(agent_id=test_agent["id"],
compartment_id=compartment_id,
display_name=tool_display_name,
state=tool_state)
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.GetAgentTools(ctx, &generativeai.GetAgentToolsArgs{
AgentId: pulumi.StringRef(testAgent.Id),
CompartmentId: pulumi.StringRef(compartmentId),
DisplayName: pulumi.StringRef(toolDisplayName),
State: pulumi.StringRef(toolState),
}, nil)
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 testTools = Oci.GenerativeAi.GetAgentTools.Invoke(new()
{
AgentId = testAgent.Id,
CompartmentId = compartmentId,
DisplayName = toolDisplayName,
State = toolState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentToolsArgs;
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) {
final var testTools = GenerativeAiFunctions.getAgentTools(GetAgentToolsArgs.builder()
.agentId(testAgent.id())
.compartmentId(compartmentId)
.displayName(toolDisplayName)
.state(toolState)
.build());
}
}
variables:
testTools:
fn::invoke:
function: oci:GenerativeAi:getAgentTools
arguments:
agentId: ${testAgent.id}
compartmentId: ${compartmentId}
displayName: ${toolDisplayName}
state: ${toolState}
Using getAgentTools
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAgentTools(args: GetAgentToolsArgs, opts?: InvokeOptions): Promise<GetAgentToolsResult>
function getAgentToolsOutput(args: GetAgentToolsOutputArgs, opts?: InvokeOptions): Output<GetAgentToolsResult>
def get_agent_tools(agent_id: Optional[str] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[GetAgentToolsFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentToolsResult
def get_agent_tools_output(agent_id: Optional[pulumi.Input[str]] = None,
compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAgentToolsFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAgentToolsResult]
func GetAgentTools(ctx *Context, args *GetAgentToolsArgs, opts ...InvokeOption) (*GetAgentToolsResult, error)
func GetAgentToolsOutput(ctx *Context, args *GetAgentToolsOutputArgs, opts ...InvokeOption) GetAgentToolsResultOutput
> Note: This function is named GetAgentTools
in the Go SDK.
public static class GetAgentTools
{
public static Task<GetAgentToolsResult> InvokeAsync(GetAgentToolsArgs args, InvokeOptions? opts = null)
public static Output<GetAgentToolsResult> Invoke(GetAgentToolsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAgentToolsResult> getAgentTools(GetAgentToolsArgs args, InvokeOptions options)
public static Output<GetAgentToolsResult> getAgentTools(GetAgentToolsArgs args, InvokeOptions options)
fn::invoke:
function: oci:GenerativeAi/getAgentTools:getAgentTools
arguments:
# arguments dictionary
The following arguments are supported:
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Agent Tools Filter> - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Agent Tools Filter - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Agent Tools Filter> - state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent
Id string - The OCID of the agent.
- compartment
Id string - The OCID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Agent Tools Filter[] - state string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent_
id str - The OCID of the agent.
- compartment_
id str - The OCID of the compartment in which to list resources.
- display_
name str - A filter to return only resources that match the given display name exactly.
- filters
Sequence[Get
Agent Tools Filter] - state str
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters List<Property Map>
- state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
getAgentTools Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Tool
Collections List<GetAgent Tools Tool Collection> - The list of tool_collection.
- Agent
Id string - The OCID of the agent that this Tool is attached to.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
List<Get
Agent Tools Filter> - State string
- The current state of the Tool.
- Id string
- The provider-assigned unique ID for this managed resource.
- Tool
Collections []GetAgent Tools Tool Collection - The list of tool_collection.
- Agent
Id string - The OCID of the agent that this Tool is attached to.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
[]Get
Agent Tools Filter - State string
- The current state of the Tool.
- id String
- The provider-assigned unique ID for this managed resource.
- tool
Collections List<GetAgent Tools Tool Collection> - The list of tool_collection.
- agent
Id String - The OCID of the agent that this Tool is attached to.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
List<Get
Agent Tools Filter> - state String
- The current state of the Tool.
- id string
- The provider-assigned unique ID for this managed resource.
- tool
Collections GetAgent Tools Tool Collection[] - The list of tool_collection.
- agent
Id string - The OCID of the agent that this Tool is attached to.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
Get
Agent Tools Filter[] - state string
- The current state of the Tool.
- id str
- The provider-assigned unique ID for this managed resource.
- tool_
collections Sequence[GetAgent Tools Tool Collection] - The list of tool_collection.
- agent_
id str - The OCID of the agent that this Tool is attached to.
- compartment_
id str - The OCID of the compartment.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
Sequence[Get
Agent Tools Filter] - state str
- The current state of the Tool.
- id String
- The provider-assigned unique ID for this managed resource.
- tool
Collections List<Property Map> - The list of tool_collection.
- agent
Id String - The OCID of the agent that this Tool is attached to.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- filters List<Property Map>
- state String
- The current state of the Tool.
Supporting Types
GetAgentToolsFilter
GetAgentToolsToolCollection
GetAgentToolsToolCollectionItem
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Dictionary<string, string>
- 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
- A description of the function.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Dictionary<string, string>
- 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"}
- Id string
- The OCID of the Tool.
- Metadata Dictionary<string, string>
- Key-value pairs to allow additional configurations.
- State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- 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
Configs List<GetAgent Tools Tool Collection Item Tool Config> - The configuration and type of Tool.
- Agent
Id string - The OCID of the agent.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- map[string]string
- 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
- A description of the function.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- map[string]string
- 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"}
- Id string
- The OCID of the Tool.
- Metadata map[string]string
- Key-value pairs to allow additional configurations.
- State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- 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
Configs []GetAgent Tools Tool Collection Item Tool Config - The configuration and type of Tool.
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String,String>
- 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
- A description of the function.
- display
Name String - A filter to return only resources that match the given display name exactly.
- Map<String,String>
- 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"}
- id String
- The OCID of the Tool.
- metadata Map<String,String>
- Key-value pairs to allow additional configurations.
- state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- 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
Configs List<GetAgent Tools Tool Collection Item Tool Config> - The configuration and type of Tool.
- agent
Id string - The OCID of the agent.
- compartment
Id string - The OCID of the compartment in which to list resources.
- {[key: string]: string}
- 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
- A description of the function.
- display
Name string - A filter to return only resources that match the given display name exactly.
- {[key: string]: string}
- 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"}
- id string
- The OCID of the Tool.
- metadata {[key: string]: string}
- Key-value pairs to allow additional configurations.
- state string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- {[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
Configs GetAgent Tools Tool Collection Item Tool Config[] - The configuration and type of Tool.
- agent_
id str - The OCID of the agent.
- compartment_
id str - The OCID of the compartment in which to list resources.
- Mapping[str, str]
- 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
- A description of the function.
- display_
name str - A filter to return only resources that match the given display name exactly.
- Mapping[str, str]
- 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"}
- id str
- The OCID of the Tool.
- metadata Mapping[str, str]
- Key-value pairs to allow additional configurations.
- state str
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- 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_
configs Sequence[GetAgent Tools Tool Collection Item Tool Config] - The configuration and type of Tool.
- agent
Id String - The OCID of the agent.
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String>
- 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
- A description of the function.
- display
Name String - A filter to return only resources that match the given display name exactly.
- Map<String>
- 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"}
- id String
- The OCID of the Tool.
- metadata Map<String>
- Key-value pairs to allow additional configurations.
- state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- 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
Configs List<Property Map> - The configuration and type of Tool.
GetAgentToolsToolCollectionItemToolConfig
- Database
Connections List<GetAgent Tools Tool Collection Item Tool Config Database Connection> - The connection type for Databases.
- Database
Schemas List<GetAgent Tools Tool Collection Item Tool Config Database Schema> - The input location definition.
- Dialect string
- Dialect to be used for SQL generation.
- Functions
List<Get
Agent Tools Tool Collection Item Tool Config Function> - Details of Function for Function calling tool.
- Generation
Llm List<GetCustomizations Agent Tools Tool Collection Item Tool Config Generation Llm Customization> - Configuration to customize LLM.
- Icl
Examples List<GetAgent Tools Tool Collection Item Tool Config Icl Example> - The input location definition.
- Knowledge
Base List<GetConfigs Agent Tools Tool Collection Item Tool Config Knowledge Base Config> - The KnowledgeBase configurations that this RAG Tool uses
- Model
Size string - Size of the model.
- Should
Enable boolSelf Correction - To enable/disable self correction.
- Should
Enable boolSql Execution - To enable/disable SQL execution.
- Table
And List<GetColumn Descriptions Agent Tools Tool Collection Item Tool Config Table And Column Description> - The input location definition.
- Tool
Config stringType - 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.
- Database
Connections []GetAgent Tools Tool Collection Item Tool Config Database Connection - The connection type for Databases.
- Database
Schemas []GetAgent Tools Tool Collection Item Tool Config Database Schema - The input location definition.
- Dialect string
- Dialect to be used for SQL generation.
- Functions
[]Get
Agent Tools Tool Collection Item Tool Config Function - Details of Function for Function calling tool.
- Generation
Llm []GetCustomizations Agent Tools Tool Collection Item Tool Config Generation Llm Customization - Configuration to customize LLM.
- Icl
Examples []GetAgent Tools Tool Collection Item Tool Config Icl Example - The input location definition.
- Knowledge
Base []GetConfigs Agent Tools Tool Collection Item Tool Config Knowledge Base Config - The KnowledgeBase configurations that this RAG Tool uses
- Model
Size string - Size of the model.
- Should
Enable boolSelf Correction - To enable/disable self correction.
- Should
Enable boolSql Execution - To enable/disable SQL execution.
- Table
And []GetColumn Descriptions Agent Tools Tool Collection Item Tool Config Table And Column Description - The input location definition.
- Tool
Config stringType - 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.
- database
Connections List<GetAgent Tools Tool Collection Item Tool Config Database Connection> - The connection type for Databases.
- database
Schemas List<GetAgent Tools Tool Collection Item Tool Config Database Schema> - The input location definition.
- dialect String
- Dialect to be used for SQL generation.
- functions
List<Get
Agent Tools Tool Collection Item Tool Config Function> - Details of Function for Function calling tool.
- generation
Llm List<GetCustomizations Agent Tools Tool Collection Item Tool Config Generation Llm Customization> - Configuration to customize LLM.
- icl
Examples List<GetAgent Tools Tool Collection Item Tool Config Icl Example> - The input location definition.
- knowledge
Base List<GetConfigs Agent Tools Tool Collection Item Tool Config Knowledge Base Config> - The KnowledgeBase configurations that this RAG Tool uses
- model
Size String - Size of the model.
- should
Enable BooleanSelf Correction - To enable/disable self correction.
- should
Enable BooleanSql Execution - To enable/disable SQL execution.
- table
And List<GetColumn Descriptions Agent Tools Tool Collection Item Tool Config Table And Column Description> - The input location definition.
- tool
Config StringType - 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.
- database
Connections GetAgent Tools Tool Collection Item Tool Config Database Connection[] - The connection type for Databases.
- database
Schemas GetAgent Tools Tool Collection Item Tool Config Database Schema[] - The input location definition.
- dialect string
- Dialect to be used for SQL generation.
- functions
Get
Agent Tools Tool Collection Item Tool Config Function[] - Details of Function for Function calling tool.
- generation
Llm GetCustomizations Agent Tools Tool Collection Item Tool Config Generation Llm Customization[] - Configuration to customize LLM.
- icl
Examples GetAgent Tools Tool Collection Item Tool Config Icl Example[] - The input location definition.
- knowledge
Base GetConfigs Agent Tools Tool Collection Item Tool Config Knowledge Base Config[] - The KnowledgeBase configurations that this RAG Tool uses
- model
Size string - Size of the model.
- should
Enable booleanSelf Correction - To enable/disable self correction.
- should
Enable booleanSql Execution - To enable/disable SQL execution.
- table
And GetColumn Descriptions Agent Tools Tool Collection Item Tool Config Table And Column Description[] - The input location definition.
- tool
Config stringType - 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.
- database_
connections Sequence[GetAgent Tools Tool Collection Item Tool Config Database Connection] - The connection type for Databases.
- database_
schemas Sequence[GetAgent Tools Tool Collection Item Tool Config Database Schema] - The input location definition.
- dialect str
- Dialect to be used for SQL generation.
- functions
Sequence[Get
Agent Tools Tool Collection Item Tool Config Function] - Details of Function for Function calling tool.
- generation_
llm_ Sequence[Getcustomizations Agent Tools Tool Collection Item Tool Config Generation Llm Customization] - Configuration to customize LLM.
- icl_
examples Sequence[GetAgent Tools Tool Collection Item Tool Config Icl Example] - The input location definition.
- knowledge_
base_ Sequence[Getconfigs Agent Tools Tool Collection Item Tool Config Knowledge Base Config] - The KnowledgeBase configurations that this RAG Tool uses
- model_
size str - Size of the model.
- should_
enable_ boolself_ correction - To enable/disable self correction.
- should_
enable_ boolsql_ execution - To enable/disable SQL execution.
- table_
and_ Sequence[Getcolumn_ descriptions Agent Tools Tool Collection Item Tool Config Table And Column Description] - The input location definition.
- tool_
config_ strtype - 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.
- database
Connections List<Property Map> - The connection type for Databases.
- database
Schemas List<Property Map> - The input location definition.
- dialect String
- Dialect to be used for SQL generation.
- functions List<Property Map>
- Details of Function for Function calling tool.
- generation
Llm List<Property Map>Customizations - Configuration to customize LLM.
- icl
Examples List<Property Map> - The input location definition.
- knowledge
Base List<Property Map>Configs - The KnowledgeBase configurations that this RAG Tool uses
- model
Size String - Size of the model.
- should
Enable BooleanSelf Correction - To enable/disable self correction.
- should
Enable BooleanSql Execution - To enable/disable SQL execution.
- table
And List<Property Map>Column Descriptions - The input location definition.
- tool
Config StringType - 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.
GetAgentToolsToolCollectionItemToolConfigDatabaseConnection
- Connection
Id string - The OCID of the Database Tools Connection.
- Connection
Type string - 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 - The OCID of the Database Tools Connection.
- Connection
Type string - 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 - The OCID of the Database Tools Connection.
- connection
Type String - 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 - The OCID of the Database Tools Connection.
- connection
Type string - 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 - The OCID of the Database Tools Connection.
- connection_
type str - 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 - The OCID of the Database Tools Connection.
- connection
Type String - 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.
GetAgentToolsToolCollectionItemToolConfigDatabaseSchema
- Bucket string
- The bucket name of an object.
- Content string
- Inline content as input.
- Input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- Namespace string
- The namespace name of an object.
- Prefix string
- The prefix of file object(s) or folder prefix.
- Bucket string
- The bucket name of an object.
- Content string
- Inline content as input.
- Input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- Namespace string
- The namespace name of an object.
- Prefix string
- The prefix of file object(s) or folder prefix.
- bucket String
- The bucket name of an object.
- content String
- Inline content as input.
- input
Location StringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace String
- The namespace name of an object.
- prefix String
- The prefix of file object(s) or folder prefix.
- bucket string
- The bucket name of an object.
- content string
- Inline content as input.
- input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace string
- The namespace name of an object.
- prefix string
- The prefix of file object(s) or folder prefix.
- bucket str
- The bucket name of an object.
- content str
- Inline content as input.
- input_
location_ strtype - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace str
- The namespace name of an object.
- prefix str
- The prefix of file object(s) or folder prefix.
- bucket String
- The bucket name of an object.
- content String
- Inline content as input.
- input
Location StringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace String
- The namespace name of an object.
- prefix String
- The prefix of file object(s) or folder prefix.
GetAgentToolsToolCollectionItemToolConfigFunction
- Description string
- A description of the function.
- Name string
- The name of the function to invoke.
- Parameters Dictionary<string, string>
- 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
- A description of the function.
- Name string
- The name of the function to invoke.
- Parameters map[string]string
- 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
- A description of the function.
- name String
- The name of the function to invoke.
- parameters Map<String,String>
- 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
- A description of the function.
- name string
- The name of the function to invoke.
- parameters {[key: string]: string}
- 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
- A description of the function.
- name str
- The name of the function to invoke.
- parameters Mapping[str, str]
- 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
- A description of the function.
- name String
- The name of the function to invoke.
- parameters Map<String>
- 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.
GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization
- Instruction string
- If specified, the default instruction is replaced with provided instruction.
- Instruction string
- If specified, the default instruction is replaced with provided instruction.
- instruction String
- If specified, the default instruction is replaced with provided instruction.
- instruction string
- If specified, the default instruction is replaced with provided instruction.
- instruction str
- If specified, the default instruction is replaced with provided instruction.
- instruction String
- If specified, the default instruction is replaced with provided instruction.
GetAgentToolsToolCollectionItemToolConfigIclExample
- Bucket string
- The bucket name of an object.
- Content string
- Inline content as input.
- Input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- Namespace string
- The namespace name of an object.
- Prefix string
- The prefix of file object(s) or folder prefix.
- Bucket string
- The bucket name of an object.
- Content string
- Inline content as input.
- Input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- Namespace string
- The namespace name of an object.
- Prefix string
- The prefix of file object(s) or folder prefix.
- bucket String
- The bucket name of an object.
- content String
- Inline content as input.
- input
Location StringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace String
- The namespace name of an object.
- prefix String
- The prefix of file object(s) or folder prefix.
- bucket string
- The bucket name of an object.
- content string
- Inline content as input.
- input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace string
- The namespace name of an object.
- prefix string
- The prefix of file object(s) or folder prefix.
- bucket str
- The bucket name of an object.
- content str
- Inline content as input.
- input_
location_ strtype - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace str
- The namespace name of an object.
- prefix str
- The prefix of file object(s) or folder prefix.
- bucket String
- The bucket name of an object.
- content String
- Inline content as input.
- input
Location StringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace String
- The namespace name of an object.
- prefix String
- The prefix of file object(s) or folder prefix.
GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig
- Knowledge
Base stringId - The OCID of the knowledgeBase this RAG Tool uses
- Knowledge
Base stringId - The OCID of the knowledgeBase this RAG Tool uses
- knowledge
Base StringId - The OCID of the knowledgeBase this RAG Tool uses
- knowledge
Base stringId - The OCID of the knowledgeBase this RAG Tool uses
- knowledge_
base_ strid - The OCID of the knowledgeBase this RAG Tool uses
- knowledge
Base StringId - The OCID of the knowledgeBase this RAG Tool uses
GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription
- Bucket string
- The bucket name of an object.
- Content string
- Inline content as input.
- Input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- Namespace string
- The namespace name of an object.
- Prefix string
- The prefix of file object(s) or folder prefix.
- Bucket string
- The bucket name of an object.
- Content string
- Inline content as input.
- Input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- Namespace string
- The namespace name of an object.
- Prefix string
- The prefix of file object(s) or folder prefix.
- bucket String
- The bucket name of an object.
- content String
- Inline content as input.
- input
Location StringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace String
- The namespace name of an object.
- prefix String
- The prefix of file object(s) or folder prefix.
- bucket string
- The bucket name of an object.
- content string
- Inline content as input.
- input
Location stringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace string
- The namespace name of an object.
- prefix string
- The prefix of file object(s) or folder prefix.
- bucket str
- The bucket name of an object.
- content str
- Inline content as input.
- input_
location_ strtype - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace str
- The namespace name of an object.
- prefix str
- The prefix of file object(s) or folder prefix.
- bucket String
- The bucket name of an object.
- content String
- Inline content as input.
- input
Location StringType - Type of InputLocation. The allowed values are:
INLINE
: The input location is inline.OBJECT_STORAGE_PREFIX
: The input location is object storage.
- namespace String
- The namespace name of an object.
- prefix String
- The prefix of file object(s) or folder prefix.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.