Search
K
OpenAI API

File search tool call

object
indexintegerrequired

The index of the tool call in the tool calls array.

idstring

The ID of the tool call object.

typestringrequired

The type of tool call. This is always going to be file_search for this type of tool call.

Allowed values:file_search

file_searchobjectrequired

For now, this is always going to be an empty object.

Example

Function tool call

object
indexintegerrequired

The index of the tool call in the tool calls array.

idstring

The ID of the tool call object.

typestringrequired

The type of tool call. This is always going to be function for this type of tool call.

Allowed values:function

functionobject

The definition of the function that was called.

Show Child Parameters
Example

Tool calls

object

Details of the tool call.

typestringrequired

Always tool_calls.

Allowed values:tool_calls

tool_callsOne Of
array

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

Code interpreter tool callobject

Details of the Code Interpreter tool call the run step was involved in.

Show Child Parameters
Example

Message creation

object

Details of the message creation by the run step.

typestringrequired

Always message_creation.

Allowed values:message_creation

message_creationobjectrequired
Show Child Parameters
Example

Code Interpreter tool call

object

Details of the Code Interpreter tool call the run step was involved in.

idstringrequired

The ID of the tool call.

typestringrequired

The type of tool call. This is always going to be code_interpreter for this type of tool call.

Allowed values:code_interpreter

code_interpreterobjectrequired

The Code Interpreter tool call definition.

Show Child Parameters
Example