Assistant interface
Represents an assistant that can call the model and use tools.
Properties
| created |
The Unix timestamp, in seconds, representing when this object was created. |
| description | The description of the assistant. |
| file |
A list of attached file IDs, ordered by creation date in ascending order. |
| id | The identifier, which can be referenced in API endpoints. |
| instructions | The system instructions for the assistant to use. |
| metadata | A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. |
| model | The ID of the model to use. |
| name | The name of the assistant. |
| tools | The collection of tools enabled for the assistant. |
Property Details
createdAt
The Unix timestamp, in seconds, representing when this object was created.
createdAt: DateProperty Value
Date
description
The description of the assistant.
description: null | stringProperty Value
null | string
fileIds
A list of attached file IDs, ordered by creation date in ascending order.
fileIds: string[]Property Value
string[]
id
The identifier, which can be referenced in API endpoints.
id: stringProperty Value
string
instructions
The system instructions for the assistant to use.
instructions: null | stringProperty Value
null | string
metadata
A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
metadata?: null | Record<string, string>Property Value
null | Record<string, string>
model
The ID of the model to use.
model: stringProperty Value
string
name
The name of the assistant.
name: null | stringProperty Value
null | string
tools
The collection of tools enabled for the assistant.
tools: ToolDefinition[]Property Value
Azure SDK for JavaScript