Microsoft Azure · Schema
createAssistantRequest
API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1
Properties
| Name | Type | Description |
|---|---|---|
| model | object | ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of t |
| name | string | The name of the assistant. The maximum length is 256 characters. |
| description | string | The description of the assistant. The maximum length is 512 characters. |
| instructions | string | The system instructions that the assistant uses. The maximum length is 32768 characters. |
| tools | array | A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. |
| file_ids | array | A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. |
| metadata | object | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/createAssistantRequest",
"title": "createAssistantRequest",
"type": "object",
"additionalProperties": false,
"properties": {
"model": {
"description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n",
"anyOf": [
{
"type": "string"
}
]
},
"name": {
"description": "The name of the assistant. The maximum length is 256 characters.\n",
"type": "string",
"nullable": true,
"maxLength": 256
},
"description": {
"description": "The description of the assistant. The maximum length is 512 characters.\n",
"type": "string",
"nullable": true,
"maxLength": 512
},
"instructions": {
"description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n",
"type": "string",
"nullable": true,
"maxLength": 32768
},
"tools": {
"description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n",
"default": [],
"type": "array",
"maxItems": 128,
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/assistantToolsCode"
},
{
"$ref": "#/components/schemas/assistantToolsRetrieval"
},
{
"$ref": "#/components/schemas/assistantToolsFunction"
}
]
}
},
"file_ids": {
"description": "A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.\n",
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n",
"type": "object",
"nullable": true
}
},
"required": [
"model"
]
}