Skip to content

Commit 93de276

Browse files
committed
small fixes
1 parent 91957fd commit 93de276

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/ai-services/openai/includes/api-versions/latest-inference-preview.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3483,7 +3483,7 @@ Create a vector store.
34833483
| 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 | |
34843484
| name | string | The name of the vector store. | No | |
34853485
| 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 | |
34873487
| 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 | |
34883488

34893489
### Responses
@@ -4361,7 +4361,7 @@ Describes a span within generated completion text. Offset 0 is the first UTF32
43614361
| Name | Type | Description | Required | Default |
43624362
|------|------|-------------|----------|---------|
43634363
| 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 | |
43654365

43664366

43674367
### contentFilterResultBase
@@ -4707,7 +4707,7 @@ This component can be one of the following:
47074707

47084708
| Name | Type | Description | Default |
47094709
|------|------|-------------|--------|
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. | |
47114711

47124712
#### name
47134713

@@ -5421,7 +5421,7 @@ The filtering reason of the retrieved document.
54215421

54225422
| Name | Type | Description | Default |
54235423
|------|------|-------------|--------|
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. | |
54255425

54265426

54275427
### toolCallType
@@ -5657,7 +5657,7 @@ Deprecated and replaced by `tool_calls`. The name and arguments of a function th
56575657
| Name | Type | Description | Required | Default |
56585658
|------|------|-------------|----------|---------|
56595659
| 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 | |
56615661

56625662

56635663
### completionUsage
@@ -5719,7 +5719,7 @@ No properties defined for this component.
57195719
| description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
57205720
| 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 | |
57215721
| 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 |
57235723

57245724

57255725
### ResponseFormatText
@@ -6410,7 +6410,7 @@ Represents an execution run on a thread.
64106410
| id | string | The identifier, which can be referenced in API endpoints. | Yes | |
64116411
| object | string | The object type, which is always `thread.run`. | Yes | |
64126412
| 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 | |
64146414
| assistant_id | string | The ID of the assistant used for execution of this run. | Yes | |
64156415
| status | string | The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. | Yes | |
64166416
| 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.
65056505
| Name | Type | Description | Required | Default |
65066506
|------|------|-------------|----------|---------|
65076507
| 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 | |
65096509
| instructions | string | Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. | No | |
65106510
| 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 | |
65116511
| additional_messages | array | Adds additional messages to the thread before creating the run. | No | |
@@ -6757,7 +6757,7 @@ Represents a message within a thread.
67576757
| id | string | The identifier, which can be referenced in API endpoints. | Yes | |
67586758
| object | string | The object type, which is always `thread.message`. | Yes | |
67596759
| 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 | |
67616761
| status | string | The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. | Yes | |
67626762
| incomplete_details | object | On an incomplete message, details about why the message is incomplete. | Yes | |
67636763
| 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.
71647164
| object | string | The object type, which is always `assistant.run.step`. | Yes | |
71657165
| created_at | integer | The Unix timestamp (in seconds) for when the run step was created. | Yes | |
71667166
| 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 | |
71687168
| run_id | string | The ID of the run that this run step is a part of. | Yes | |
71697169
| type | string | The type of run step, which can be either `message_creation` or `tool_calls`. | Yes | |
71707170
| 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
77237723
| 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 | |
77247724
| name | string | The name of the vector store. | No | |
77257725
| 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 | |
77277727
| 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 | |
77287728

77297729

@@ -7783,7 +7783,7 @@ A list of files attached to a vector store.
77837783
| vector_store_id | string | The ID of the vector store that the file is attached to. | Yes | |
77847784
| 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 | |
77857785
| 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 | |
77877787

77887788

77897789
### Properties for last_error
@@ -8504,7 +8504,7 @@ Occurs when a message is completed.
85048504

85058505
#### thread.message.incomplete
85068506

8507-
Occurs when a message ends before it is completed.
8507+
Occurs when a message ends before it's completed.
85088508

85098509
| Name | Type | Description | Required | Default |
85108510
|------|------|-------------|----------|---------|

0 commit comments

Comments
 (0)