Search
K
OpenAI API

Code Interpreter image output

object
typestringrequired

Always image.

Allowed values:image

imageobjectrequired
Show Child Parameters
Example

Code Interpreter log output

object

Text output from the Code Interpreter tool call as part of a run step.

typestringrequired

Always logs.

Allowed values:logs

logsstringrequired

The text output from the Code Interpreter tool call.

Example

File search tool call

object
idstringrequired

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.

Show Child Parameters
Example

File search tool call ranking options

object

The ranking options for the file search.

rankerstringrequired

The ranker used for the file search.

Allowed values:default_2024_08_21

score_thresholdnumberrequired

The score threshold for the file search. All values must be a floating point number between 0 and 1.

>= 0<= 1

Example

File search tool call result

object

A result instance of the file search.

file_idstringrequired

The ID of the file that result was found in.

file_namestringrequired

The name of the file that result was found in.

scorenumberrequired

The score of the result. All values must be a floating point number between 0 and 1.

>= 0<= 1

contentarray[object]

The content of the result that was found. The content is only included if requested via the include query parameter.

Show Child Parameters
Example