Skip to main content

OpenAI Data Types

This page describes all the Object types defined and used by OpenAI activities.

MessageResult

Properties

PropertyTypeDescription
RawMessageStringMessage returned by OpenAI with annotations.
AnnotationsList<Annotation>Additional metadata or notes associated with a particular message. These annotations provide context, explanations, or specific instructions that help clarify the intent or content of the message.
MessageStringMessage after annotation text is cleared from the raw message.
AttachmentsList<Attachment>List of file information created in the chat.
CreatedAtInt64The Unix timestamp (in seconds) on which the message was created.
CompletedAtInt64The Unix timestamp (in seconds) on when the message was completed.

Annotation

Properties

PropertyTypeDescription
TypeStringType of the object always file_citation.
TextStringThe text in the raw message that needs to be replaced in the raw message.
StartIndexInt32The start index text in the raw message.
EndIndexInt32The end index text in the raw message.
FileCitationFileCitationA citation within the raw 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 for files.

FileCitation

Properties

PropertyTypeDescription
FilePathStringThe path of the specific file the citation is from.

Attachment

Properties

PropertyTypeDescription
File IDStringUnique identifier of the created file.
ToolsList<String>List of tools used to in the file creation.