Skip to content

Commit 91957fd

Browse files
committed
update
1 parent 203cf36 commit 91957fd

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ Creates a completion for the chat message
295295
| top_p | number | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.<br><br>We generally recommend altering this or `temperature` but not both.<br> | No | 1 |
296296
| stream | boolean | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message.<br> | No | False |
297297
| stop | string or array | Up to four sequences where the API will stop generating further tokens.<br> | No | |
298-
| max_tokens | integer | The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.<br><br>The total length of input tokens and generated tokens is limited by the model's context length. <br> | No | |
298+
| max_tokens | integer | The maximum number of tokens that can be generated in the chat completion.<br><br>The total length of input tokens and generated tokens is limited by the model's context length. <br> | No | |
299299
| max_completion_tokens | integer | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. This is only supported in o1 series models. Will expand the support to other models in future API release. | No | |
300300
| presence_penalty | number | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.<br> | No | 0 |
301301
| frequency_penalty | number | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.<br> | No | 0 |
@@ -2199,7 +2199,7 @@ Create a message.
21992199

22002200
|**Content-Type**|**Type**|**Description**|
22012201
|:---|:---|:---|
2202-
|application/json | [messageObject](#messageobject) | Represents a message within a threads.|
2202+
|application/json | [messageObject](#messageobject) | Represents a message within a thread.|
22032203

22042204
### Examples
22052205

@@ -2275,7 +2275,7 @@ Retrieve a message.
22752275

22762276
|**Content-Type**|**Type**|**Description**|
22772277
|:---|:---|:---|
2278-
|application/json | [messageObject](#messageobject) | Represents a message within a threads.|
2278+
|application/json | [messageObject](#messageobject) | Represents a message within a thread.|
22792279

22802280
### Examples
22812281

@@ -2354,7 +2354,7 @@ Modifies a message.
23542354

23552355
|**Content-Type**|**Type**|**Description**|
23562356
|:---|:---|:---|
2357-
|application/json | [messageObject](#messageobject) | Represents a message within a threads.|
2357+
|application/json | [messageObject](#messageobject) | Represents a message within a thread.|
23582358

23592359
### Examples
23602360

@@ -2472,7 +2472,7 @@ Create a thread and run it in one request.
24722472

24732473
|**Content-Type**|**Type**|**Description**|
24742474
|:---|:---|:---|
2475-
|application/json | [runObject](#runobject) | Represents an execution run on a threads.|
2475+
|application/json | [runObject](#runobject) | Represents an execution run on a thread.|
24762476

24772477
### Examples
24782478

@@ -2743,7 +2743,7 @@ Create a run.
27432743

27442744
|**Content-Type**|**Type**|**Description**|
27452745
|:---|:---|:---|
2746-
|application/json | [runObject](#runobject) | Represents an execution run on a threads.|
2746+
|application/json | [runObject](#runobject) | Represents an execution run on a thread.|
27472747

27482748
### Examples
27492749

@@ -2832,7 +2832,7 @@ Retrieves a run.
28322832

28332833
|**Content-Type**|**Type**|**Description**|
28342834
|:---|:---|:---|
2835-
|application/json | [runObject](#runobject) | Represents an execution run on a threads.|
2835+
|application/json | [runObject](#runobject) | Represents an execution run on a thread.|
28362836

28372837
### Examples
28382838

@@ -2910,7 +2910,7 @@ Modifies a run.
29102910

29112911
|**Content-Type**|**Type**|**Description**|
29122912
|:---|:---|:---|
2913-
|application/json | [runObject](#runobject) | Represents an execution run on a threads.|
2913+
|application/json | [runObject](#runobject) | Represents an execution run on a thread.|
29142914

29152915
### Examples
29162916

@@ -3025,7 +3025,7 @@ When a run has the `status: "requires_action"` and `required_action.type` is `su
30253025

30263026
|**Content-Type**|**Type**|**Description**|
30273027
|:---|:---|:---|
3028-
|application/json | [runObject](#runobject) | Represents an execution run on a threads.|
3028+
|application/json | [runObject](#runobject) | Represents an execution run on a thread.|
30293029

30303030
### Examples
30313031

@@ -3142,7 +3142,7 @@ Cancels a run that is `in_progress`.
31423142

31433143
|**Content-Type**|**Type**|**Description**|
31443144
|:---|:---|:---|
3145-
|application/json | [runObject](#runobject) | Represents an execution run on a threads.|
3145+
|application/json | [runObject](#runobject) | Represents an execution run on a thread.|
31463146

31473147
### Examples
31483148

@@ -4609,7 +4609,7 @@ Represents a completion response from the API. Note: both the streamed and non-s
46094609
| top_p | number | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.<br><br>We generally recommend altering this or `temperature` but not both.<br> | No | 1 |
46104610
| stream | boolean | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message.<br> | No | False |
46114611
| stop | string or array | Up to 4 sequences where the API will stop generating further tokens.<br> | No | |
4612-
| max_tokens | integer | The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.<br><br>The total length of input tokens and generated tokens is limited by the model's context length. <br> | No | |
4612+
| max_tokens | integer | The maximum number of tokens that can be generated in the chat completion.<br><br>The total length of input tokens and generated tokens is limited by the model's context length. <br> | No | |
46134613
| max_completion_tokens | integer | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. This is only supported in o1 series models. Will expand the support to other models in future API release. | No | |
46144614
| presence_penalty | number | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.<br> | No | 0 |
46154615
| frequency_penalty | number | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.<br> | No | 0 |
@@ -6403,7 +6403,7 @@ Specifies a tool the model should use. Use to force the model to call a specific
64036403

64046404
### runObject
64056405

6406-
Represents an execution run on a threads.
6406+
Represents an execution run on a thread.
64076407

64086408
| Name | Type | Description | Required | Default |
64096409
|------|------|-------------|----------|---------|
@@ -6750,7 +6750,7 @@ Represents a thread that contains messages.
67506750

67516751
### messageObject
67526752

6753-
Represents a message within a threads.
6753+
Represents a message within a thread.
67546754

67556755
| Name | Type | Description | Required | Default |
67566756
|------|------|-------------|----------|---------|
@@ -8075,7 +8075,7 @@ Occurs when a new run is created.
80758075
| Name | Type | Description | Required | Default |
80768076
|------|------|-------------|----------|---------|
80778077
| event | string | | Yes | |
8078-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8078+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
80798079

80808080

80818081

@@ -8096,7 +8096,7 @@ Occurs when a run moves to a `queued` status.
80968096
| Name | Type | Description | Required | Default |
80978097
|------|------|-------------|----------|---------|
80988098
| event | string | | Yes | |
8099-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8099+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
81008100

81018101

81028102

@@ -8117,7 +8117,7 @@ Occurs when a run moves to an `in_progress` status.
81178117
| Name | Type | Description | Required | Default |
81188118
|------|------|-------------|----------|---------|
81198119
| event | string | | Yes | |
8120-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8120+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
81218121

81228122

81238123

@@ -8138,7 +8138,7 @@ Occurs when a run moves to a `requires_action` status.
81388138
| Name | Type | Description | Required | Default |
81398139
|------|------|-------------|----------|---------|
81408140
| event | string | | Yes | |
8141-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8141+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
81428142

81438143

81448144

@@ -8159,7 +8159,7 @@ Occurs when a run is completed.
81598159
| Name | Type | Description | Required | Default |
81608160
|------|------|-------------|----------|---------|
81618161
| event | string | | Yes | |
8162-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8162+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
81638163

81648164

81658165

@@ -8180,7 +8180,7 @@ Occurs when a run fails.
81808180
| Name | Type | Description | Required | Default |
81818181
|------|------|-------------|----------|---------|
81828182
| event | string | | Yes | |
8183-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8183+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
81848184

81858185

81868186

@@ -8201,7 +8201,7 @@ Occurs when a run moves to a `cancelling` status.
82018201
| Name | Type | Description | Required | Default |
82028202
|------|------|-------------|----------|---------|
82038203
| event | string | | Yes | |
8204-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8204+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
82058205

82068206

82078207

@@ -8222,7 +8222,7 @@ Occurs when a run is cancelled.
82228222
| Name | Type | Description | Required | Default |
82238223
|------|------|-------------|----------|---------|
82248224
| event | string | | Yes | |
8225-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8225+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
82268226

82278227

82288228

@@ -8243,7 +8243,7 @@ Occurs when a run expires.
82438243
| Name | Type | Description | Required | Default |
82448244
|------|------|-------------|----------|---------|
82458245
| event | string | | Yes | |
8246-
| data | [runObject](#runobject) | Represents an execution run on a threads. | Yes | |
8246+
| data | [runObject](#runobject) | Represents an execution run on a thread. | Yes | |
82478247

82488248

82498249

@@ -8425,7 +8425,7 @@ Occurs when a message is created.
84258425
| Name | Type | Description | Required | Default |
84268426
|------|------|-------------|----------|---------|
84278427
| event | string | | Yes | |
8428-
| data | [messageObject](#messageobject) | Represents a message within a threads. | Yes | |
8428+
| data | [messageObject](#messageobject) | Represents a message within a thread. | Yes | |
84298429

84308430

84318431

@@ -8446,7 +8446,7 @@ Occurs when a message moves to an `in_progress` state.
84468446
| Name | Type | Description | Required | Default |
84478447
|------|------|-------------|----------|---------|
84488448
| event | string | | Yes | |
8449-
| data | [messageObject](#messageobject) | Represents a message within a threads. | Yes | |
8449+
| data | [messageObject](#messageobject) | Represents a message within a thread. | Yes | |
84508450

84518451

84528452

@@ -8488,7 +8488,7 @@ Occurs when a message is completed.
84888488
| Name | Type | Description | Required | Default |
84898489
|------|------|-------------|----------|---------|
84908490
| event | string | | Yes | |
8491-
| data | [messageObject](#messageobject) | Represents a message within a threads. | Yes | |
8491+
| data | [messageObject](#messageobject) | Represents a message within a thread. | Yes | |
84928492

84938493

84948494

@@ -8509,7 +8509,7 @@ Occurs when a message ends before it is completed.
85098509
| Name | Type | Description | Required | Default |
85108510
|------|------|-------------|----------|---------|
85118511
| event | string | | Yes | |
8512-
| data | [messageObject](#messageobject) | Represents a message within a threads. | Yes | |
8512+
| data | [messageObject](#messageobject) | Represents a message within a thread. | Yes | |
85138513

85148514

85158515

0 commit comments

Comments
 (0)