OpenAI API

Refusal

object

The refusal content generated by the assistant.

typestringrequired

Always refusal.

Allowed values:refusal

refusalstringrequired
Example

File citation

object

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.

typestringrequired

Always file_citation.

Allowed values:file_citation

textstringrequired

The text in the message content that needs to be replaced.

file_citationobjectrequired
Show Child Parameters
start_indexintegerrequired

>= 0

end_indexintegerrequired

>= 0

Example

File path

object

A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file.

typestringrequired

Always file_path.

Allowed values:file_path

textstringrequired

The text in the message content that needs to be replaced.

file_pathobjectrequired
Show Child Parameters
start_indexintegerrequired

>= 0

end_indexintegerrequired

>= 0

Example

Text

object

The text content that is part of a message.

typestringrequired

Always text.

Allowed values:text

textobjectrequired
Show Child Parameters
Example

Image file

object

References an image File in the content of a message.

indexintegerrequired

The index of the content part in the message.

typestringrequired

Always image_file.

Allowed values:image_file

image_fileobject
Show Child Parameters
Example