Microsoft Azure · Schema
createMessageRequest
API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1
Properties
| Name | Type | Description |
|---|---|---|
| role | string | The role of the entity that is creating the message. Currently only `user` is supported. |
| content | string | The content of the message. |
| file_ids | array | A list of [File](/docs/api-reference/files) IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like `retrieval` and `code_interpreter` that can |
| 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/createMessageRequest",
"title": "createMessageRequest",
"type": "object",
"additionalProperties": false,
"required": [
"role",
"content"
],
"properties": {
"role": {
"type": "string",
"enum": [
"user"
],
"x-ms-enum": {
"name": "CreateMessageRequestRole",
"modelAsString": true,
"values": [
{
"value": "user",
"description": "The create message role as `user`"
}
]
},
"description": "The role of the entity that is creating the message. Currently only `user` is supported."
},
"content": {
"type": "string",
"minLength": 1,
"maxLength": 32768,
"description": "The content of the message."
},
"file_ids": {
"description": "A list of [File](/docs/api-reference/files) IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like `retrieval` and `code_interpreter` that can access and use files.",
"default": [],
"type": "array",
"minItems": 1,
"maxItems": 10,
"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
}
}
}