OpenAI API

Refusal

object

The refusal content that is part of a message.

indexintegerrequired

The index of the refusal part in the message.

typestringrequired

Always refusal.

Allowed values:refusal

refusalstring
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.

indexintegerrequired

The index of the annotation in the text content part.

typestringrequired

Always file_citation.

Allowed values:file_citation

textstring

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

file_citationobject
Show Child Parameters
start_indexinteger

>= 0

end_indexinteger

>= 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.

indexintegerrequired

The index of the annotation in the text content part.

typestringrequired

Always file_path.

Allowed values:file_path

textstring

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

file_pathobject
Show Child Parameters
start_indexinteger

>= 0

end_indexinteger

>= 0

Example

Text

object

The text content that is part of a message.

indexintegerrequired

The index of the content part in the message.

typestringrequired

Always text.

Allowed values:text

textobject
Show Child Parameters
Example

Message delta object

object

Represents a message delta i.e. any changed fields on a message during streaming.

idstringrequired

The identifier of the message, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always thread.message.delta.

Allowed values:thread.message.delta

deltaobjectrequired

The delta containing the fields that have changed on the Message.

Show Child Parameters
Example