You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/openai/includes/api-versions/latest-inference-preview.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3483,7 +3483,7 @@ Create a vector store.
3483
3483
| file_ids | array | A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. | No ||
3484
3484
| name | string | The name of the vector store. | No ||
3485
3485
| expires_after |[vectorStoreExpirationAfter](#vectorstoreexpirationafter)| The expiration policy for a vector store. | No ||
3486
-
| chunking_strategy |[autoChunkingStrategyRequestParam](#autochunkingstrategyrequestparam) or [staticChunkingStrategyRequestParam](#staticchunkingstrategyrequestparam)| The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty. | No ||
3486
+
| chunking_strategy |[autoChunkingStrategyRequestParam](#autochunkingstrategyrequestparam) or [staticChunkingStrategyRequestParam](#staticchunkingstrategyrequestparam)| The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is nonempty. | No ||
3487
3487
| 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 and values can be a maximum of 512 characters long.<br> | No ||
3488
3488
3489
3489
### Responses
@@ -4361,7 +4361,7 @@ Describes a span within generated completion text. Offset 0 is the first UTF32
4361
4361
| Name | Type | Description | Required | Default |
| completion_start_offset | integer | Offset of the UTF32 code point which begins the span. | Yes ||
4364
-
| completion_end_offset | integer | Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for non-empty spans. | Yes ||
4364
+
| completion_end_offset | integer | Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for nonempty spans. | Yes ||
4365
4365
4366
4366
4367
4367
### contentFilterResultBase
@@ -4707,7 +4707,7 @@ This component can be one of the following:
4707
4707
4708
4708
| Name | Type | Description | Default |
4709
4709
|------|------|-------------|--------|
4710
-
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. ||
4710
+
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may generate parameters not defined by your function schema. Validate the arguments in your code before calling your function. ||
4711
4711
4712
4712
#### name
4713
4713
@@ -5421,7 +5421,7 @@ The filtering reason of the retrieved document.
5421
5421
5422
5422
| Name | Type | Description | Default |
5423
5423
|------|------|-------------|--------|
5424
-
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. Note that the model doesn't always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. ||
5424
+
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. Note that the model doesn't always generate valid JSON, and may generate parameters not defined by your function schema. Validate the arguments in your code before calling your function. ||
5425
5425
5426
5426
5427
5427
### toolCallType
@@ -5657,7 +5657,7 @@ Deprecated and replaced by `tool_calls`. The name and arguments of a function th
5657
5657
| Name | Type | Description | Required | Default |
| name | string | The name of the function to call. | Yes ||
5660
-
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. Note that the model doesn't always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. | Yes ||
5660
+
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. Note that the model doesn't always generate valid JSON, and may generate parameters not defined by your function schema. Validate the arguments in your code before calling your function. | Yes ||
5661
5661
5662
5662
5663
5663
### completionUsage
@@ -5719,7 +5719,7 @@ No properties defined for this component.
5719
5719
| description | string | A description of what the function does, used by the model to choose when and how to call the function. | No ||
5720
5720
| name | string | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | Yes ||
5721
5721
| parameters |[FunctionParameters](#functionparameters)| The parameters the functions accepts, described as a JSON Schema object. [See the guide](/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. <br><br>Omitting `parameters` defines a function with an empty parameter list. | No ||
5722
-
| strict | boolean | Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling). | No | False |
5722
+
| strict | boolean | Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. | No | False |
5723
5723
5724
5724
5725
5725
### ResponseFormatText
@@ -6410,7 +6410,7 @@ Represents an execution run on a thread.
6410
6410
| id | string | The identifier, which can be referenced in API endpoints. | Yes ||
6411
6411
| object | string | The object type, which is always `thread.run`. | Yes ||
6412
6412
| created_at | integer | The Unix timestamp (in seconds) for when the run was created. | Yes ||
6413
-
| thread_id | string | The ID of the threads that was executed on as a part of this run. | Yes ||
6413
+
| thread_id | string | The ID of the thread that was executed on as a part of this run. | Yes ||
6414
6414
| assistant_id | string | The ID of the assistant used for execution of this run. | Yes ||
6415
6415
| status | string | The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. | Yes ||
6416
6416
| required_action | object | Details on the action required to continue the run. Will be `null` if no action is required. | Yes ||
@@ -6505,7 +6505,7 @@ Represents an execution run on a thread.
6505
6505
| Name | Type | Description | Required | Default |
| assistant_id | string | The ID of the assistant to use to execute this run. | Yes ||
6508
-
| model | string | The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. | No ||
6508
+
| model | string | The deployment ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. | No ||
6509
6509
| instructions | string | Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. | No ||
6510
6510
| additional_instructions | string | Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. | No ||
6511
6511
| additional_messages | array | Adds additional messages to the thread before creating the run. | No ||
@@ -6757,7 +6757,7 @@ Represents a message within a thread.
6757
6757
| id | string | The identifier, which can be referenced in API endpoints. | Yes ||
6758
6758
| object | string | The object type, which is always `thread.message`. | Yes ||
6759
6759
| created_at | integer | The Unix timestamp (in seconds) for when the message was created. | Yes ||
6760
-
| thread_id | string |The threads ID that this message belongs to. | Yes ||
6760
+
| thread_id | string |the thread ID that this message belongs to. | Yes ||
6761
6761
| status | string | The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. | Yes ||
6762
6762
| incomplete_details | object | On an incomplete message, details about why the message is incomplete. | Yes ||
6763
6763
| completed_at | integer | The Unix timestamp (in seconds) for when the message was completed. | Yes ||
@@ -7164,7 +7164,7 @@ Represents a step in execution of a run.
7164
7164
| object | string | The object type, which is always `assistant.run.step`. | Yes ||
7165
7165
| created_at | integer | The Unix timestamp (in seconds) for when the run step was created. | Yes ||
7166
7166
| assistant_id | string | The ID of the assistant associated with the run step. | Yes ||
7167
-
| thread_id | string | The ID of the threads that was run. | Yes ||
7167
+
| thread_id | string | The ID of the thread that was run. | Yes ||
7168
7168
| run_id | string | The ID of the run that this run step is a part of. | Yes ||
7169
7169
| type | string | The type of run step, which can be either `message_creation` or `tool_calls`. | Yes ||
7170
7170
| status | string | The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. | Yes ||
@@ -7723,7 +7723,7 @@ A vector store is a collection of processed files can be used by the `file_searc
7723
7723
| file_ids | array | A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. | No ||
7724
7724
| name | string | The name of the vector store. | No ||
7725
7725
| expires_after |[vectorStoreExpirationAfter](#vectorstoreexpirationafter)| The expiration policy for a vector store. | No ||
7726
-
| chunking_strategy |[autoChunkingStrategyRequestParam](#autochunkingstrategyrequestparam) or [staticChunkingStrategyRequestParam](#staticchunkingstrategyrequestparam)| The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty. | No ||
7726
+
| chunking_strategy |[autoChunkingStrategyRequestParam](#autochunkingstrategyrequestparam) or [staticChunkingStrategyRequestParam](#staticchunkingstrategyrequestparam)| The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is nonempty. | No ||
7727
7727
| 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 and values can be a maximum of 512 characters long.<br> | No ||
7728
7728
7729
7729
@@ -7783,7 +7783,7 @@ A list of files attached to a vector store.
7783
7783
| vector_store_id | string | The ID of the vector store that the file is attached to. | Yes ||
7784
7784
| status | string | The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. | Yes ||
7785
7785
| last_error | object | The last error associated with this vector store file. Will be `null` if there are no errors. | Yes ||
7786
-
| chunking_strategy |[autoChunkingStrategyRequestParam](#autochunkingstrategyrequestparam) or [staticChunkingStrategyRequestParam](#staticchunkingstrategyrequestparam)| The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty. | No ||
7786
+
| chunking_strategy |[autoChunkingStrategyRequestParam](#autochunkingstrategyrequestparam) or [staticChunkingStrategyRequestParam](#staticchunkingstrategyrequestparam)| The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is nonempty. | No ||
7787
7787
7788
7788
7789
7789
### Properties for last_error
@@ -8504,7 +8504,7 @@ Occurs when a message is completed.
8504
8504
8505
8505
#### thread.message.incomplete
8506
8506
8507
-
Occurs when a message ends before it is completed.
8507
+
Occurs when a message ends before it's completed.
8508
8508
8509
8509
| Name | Type | Description | Required | Default |
0 commit comments