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: openapi.yaml
+47-11Lines changed: 47 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ openapi: 3.0.0
2
2
info:
3
3
title: OpenAI API
4
4
description: APIs for sampling from and fine-tuning language models
5
-
version: '1.3.0'
5
+
version: '1.3.1'
6
6
servers:
7
7
- url: https://api.openai.com/v1
8
8
tags:
@@ -2073,9 +2073,13 @@ components:
2073
2073
CreateCompletionRequest:
2074
2074
type: object
2075
2075
properties:
2076
-
model: &model_configuration
2077
-
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.
2078
-
type: string
2076
+
model:
2077
+
description: &model_description |
2078
+
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.
The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
@@ -2411,7 +2415,11 @@ components:
2411
2415
properties:
2412
2416
model:
2413
2417
description: ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API.
description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).
2417
2425
type: array
@@ -2593,6 +2601,11 @@ components:
2593
2601
model:
2594
2602
description: ID of the model to use. You can use the `text-davinci-edit-001` or `code-davinci-edit-001` model with this endpoint.
The input text to use as a starting point for the edit.
@@ -2798,10 +2811,13 @@ components:
2798
2811
Two content moderations models are available: `text-moderation-stable` and `text-moderation-latest`.
2799
2812
2800
2813
The default is `text-moderation-latest` which will be automatically upgraded over time. This ensures you are always using our most accurate model. If you use `text-moderation-stable`, we will provide advanced notice before updating the model. Accuracy of `text-moderation-stable` may be slightly lower than for `text-moderation-latest`.
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.
The number of epochs to train the model for. An epoch refers to one
@@ -3416,7 +3438,13 @@ components:
3416
3438
type: object
3417
3439
additionalProperties: false
3418
3440
properties:
3419
-
model: *model_configuration
3441
+
model:
3442
+
description: *model_description
3443
+
example: "text-embedding-ada-002"
3444
+
oneOf:
3445
+
- type: string
3446
+
- type: string
3447
+
enum: ["text-embedding-ada-002"]
3420
3448
input:
3421
3449
description: |
3422
3450
Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. Each input must not exceed the max input tokens for the model (8191 tokens for `text-embedding-ada-002`). [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb) for counting tokens.
@@ -3501,7 +3529,11 @@ components:
3501
3529
model:
3502
3530
description: |
3503
3531
ID of the model to use. Only `whisper-1` is currently available.
3504
-
type: string
3532
+
example: whisper-1
3533
+
oneOf:
3534
+
- type: string
3535
+
- type: string
3536
+
enum: ["whisper-1"]
3505
3537
prompt:
3506
3538
description: |
3507
3539
An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language.
@@ -3546,7 +3578,11 @@ components:
3546
3578
model:
3547
3579
description: |
3548
3580
ID of the model to use. Only `whisper-1` is currently available.
3549
-
type: string
3581
+
example: whisper-1
3582
+
oneOf:
3583
+
- type: string
3584
+
- type: string
3585
+
enum: ["whisper-1"]
3550
3586
prompt:
3551
3587
description: |
3552
3588
An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English.
0 commit comments