File search tool call ranking options
objectThe ranking options for the file search.
The ranker used for the file search.
Allowed values:default_2024_08_21
The score threshold for the file search. All values must be a floating point number between 0 and 1.
>= 0<= 1
File search tool call result
objectA result instance of the file search.
The ID of the file that result was found in.
The name of the file that result was found in.
The score of the result. All values must be a floating point number between 0 and 1.
>= 0<= 1
The content of the result that was found. The content is only included if requested via the include query parameter.
Show Child Parameters
Function tool call
objectThe ID of the tool call object.
The type of tool call. This is always going to be function for this type of tool call.
Allowed values:function
The definition of the function that was called.
Show Child Parameters
Tool calls
objectDetails of the tool call.
Always tool_calls.
Allowed values:tool_calls
One OfAn 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.
Details of the Code Interpreter tool call the run step was involved in.
Show Child Parameters
Run steps
objectRepresents a step in execution of a run.
The identifier of the run step, which can be referenced in API endpoints.
The object type, which is always thread.run.step.
Allowed values:thread.run.step
The Unix timestamp (in seconds) for when the run step was created.
The ID of the assistant associated with the run step.
The ID of the thread that was run.
The ID of the run that this run step is a part of.
The type of run step, which can be either message_creation or tool_calls.
Allowed values:message_creationtool_calls
The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
Allowed values:in_progresscancelledfailedcompletedexpired
One OfThe details of the run step.
Details of the message creation by the run step.
Show Child Parameters
The last error associated with this run step. Will be null if there are no errors.
Show Child Parameters
The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
The Unix timestamp (in seconds) for when the run step was cancelled.
The Unix timestamp (in seconds) for when the run step failed.
The Unix timestamp (in seconds) for when the run step completed.
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
Usage statistics related to the run step. This value will be null while the run step’s status is in_progress.