OpenAI Data Types
This page describes all the Object types defined and used by OpenAI activities.
MessageResult
Properties
| Property | Type | Description |
|---|---|---|
| RawMessage | String | Message returned by OpenAI with annotations. |
| Annotations | List<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. |
| Message | String | Message after annotation text is cleared from the raw message. |
| CreatedAt | Int64 | The Unix timestamp (in seconds) on when the message was created. |
| CompletedAt | Int64 | The Unix timestamp (in seconds) on when the message was completed. |
Annotation
Properties
| Property | Type | Description |
|---|---|---|
| Type | String | Type of the object always file_citation. |
| Text | String | The text in the raw message that needs to be replaced in the raw message. |
| StartIndex | Int32 | The start index text in the raw message. |
| EndIndex | Int32 | The end index text in the raw message. |
| FileCitation | FileCitation | A 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 files. |
FileCitation
Properties
| Property | Type | Description |
|---|---|---|
| FilePath | String | The path of the specific file the citation is from. |