feat(api): add support for predicted outputs (#1172)

openai · Nov 4, 2024 · 08a7bb4 · 08a7bb4
1 parent e0b675f
commit 08a7bb4
Show file tree

Hide file tree

Showing 26 changed files with 133 additions and 80 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-7b0a5d715d94f75ac7795bd4d2175a0e3243af9b935a86c273f371e45583140f.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-2f8ca92b9b1879fd535b685e4767338413fcd533d42f3baac13a9c41da3fce35.yml
diff --git a/api.md b/api.md
@@ -48,6 +48,7 @@ Types:
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionMessageToolCall</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionModality</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionNamedToolChoice</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionPredictionContent</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionRole</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionStreamOptions</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionSystemMessageParam</a></code>

diff --git a/src/index.ts b/src/index.ts
@@ -87,6 +87,7 @@ import {
   ChatCompletionMessageToolCall,
   ChatCompletionModality,
   ChatCompletionNamedToolChoice,
+  ChatCompletionPredictionContent,
   ChatCompletionRole,
   ChatCompletionStreamOptions,
   ChatCompletionSystemMessageParam,
@@ -379,6 +380,7 @@ export declare namespace OpenAI {
     type ChatCompletionMessageToolCall as ChatCompletionMessageToolCall,
     type ChatCompletionModality as ChatCompletionModality,
     type ChatCompletionNamedToolChoice as ChatCompletionNamedToolChoice,
+    type ChatCompletionPredictionContent as ChatCompletionPredictionContent,
     type ChatCompletionRole as ChatCompletionRole,
     type ChatCompletionStreamOptions as ChatCompletionStreamOptions,
     type ChatCompletionSystemMessageParam as ChatCompletionSystemMessageParam,

diff --git a/src/resources/audio/speech.ts b/src/resources/audio/speech.ts
@@ -22,7 +22,7 @@ export interface SpeechCreateParams {
   input: string;
 
   /**
-   * One of the available [TTS models](https://platform.openai.com/docs/models/tts):
+   * One of the available [TTS models](https://platform.openai.com/docs/models#tts):
    * `tts-1` or `tts-1-hd`
    */
   model: (string & {}) | SpeechModel;
@@ -31,7 +31,7 @@ export interface SpeechCreateParams {
    * The voice to use when generating the audio. Supported voices are `alloy`,
    * `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are
    * available in the
-   * [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech/voice-options).
+   * [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
    */
   voice: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
 

diff --git a/src/resources/audio/transcriptions.ts b/src/resources/audio/transcriptions.ts
@@ -174,7 +174,7 @@ export interface TranscriptionCreateParams<
   /**
    * An optional text to guide the model's style or continue a previous audio
    * segment. The
-   * [prompt](https://platform.openai.com/docs/guides/speech-to-text/prompting)
+   * [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
    * should match the audio language.
    */
   prompt?: string;

diff --git a/src/resources/audio/translations.ts b/src/resources/audio/translations.ts
@@ -76,7 +76,7 @@ export interface TranslationCreateParams<
   /**
    * An optional text to guide the model's style or continue a previous audio
    * segment. The
-   * [prompt](https://platform.openai.com/docs/guides/speech-to-text/prompting)
+   * [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
    * should be in English.
    */
   prompt?: string;

diff --git a/src/resources/beta/assistants.ts b/src/resources/beta/assistants.ts
@@ -121,8 +121,8 @@ export interface Assistant {
    * ID of the model to use. You can use the
    * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
    * see all of your available models, or see our
-   * [Model overview](https://platform.openai.com/docs/models/overview) for
-   * descriptions of them.
+   * [Model overview](https://platform.openai.com/docs/models) for descriptions of
+   * them.
    */
   model: string;
 
@@ -145,8 +145,8 @@ export interface Assistant {
 
   /**
    * Specifies the format that the model must output. Compatible with
-   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
-   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
    * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
@@ -620,7 +620,7 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when an
-   * [error](https://platform.openai.com/docs/guides/error-codes/api-errors) occurs.
+   * [error](https://platform.openai.com/docs/guides/error-codes#api-errors) occurs.
    * This can happen due to an internal server error or a timeout.
    */
   export interface ErrorEvent {
@@ -663,7 +663,7 @@ export namespace FileSearchTool {
      *
      * Note that the file search tool may output fewer than `max_num_results` results.
      * See the
-     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
      * for more information.
      */
     max_num_results?: number;
@@ -673,7 +673,7 @@ export namespace FileSearchTool {
      * will use the `auto` ranker and a score_threshold of 0.
      *
      * See the
-     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
      * for more information.
      */
     ranking_options?: FileSearch.RankingOptions;
@@ -685,7 +685,7 @@ export namespace FileSearchTool {
      * will use the `auto` ranker and a score_threshold of 0.
      *
      * See the
-     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
      * for more information.
      */
     export interface RankingOptions {
@@ -1100,8 +1100,8 @@ export interface AssistantCreateParams {
    * ID of the model to use. You can use the
    * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
    * see all of your available models, or see our
-   * [Model overview](https://platform.openai.com/docs/models/overview) for
-   * descriptions of them.
+   * [Model overview](https://platform.openai.com/docs/models) for descriptions of
+   * them.
    */
   model: (string & {}) | ChatAPI.ChatModel;
 
@@ -1131,8 +1131,8 @@ export interface AssistantCreateParams {
 
   /**
    * Specifies the format that the model must output. Compatible with
-   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
-   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
    * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
@@ -1277,8 +1277,8 @@ export interface AssistantUpdateParams {
    * ID of the model to use. You can use the
    * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
    * see all of your available models, or see our
-   * [Model overview](https://platform.openai.com/docs/models/overview) for
-   * descriptions of them.
+   * [Model overview](https://platform.openai.com/docs/models) for descriptions of
+   * them.
    */
   model?: string;
 
@@ -1289,8 +1289,8 @@ export interface AssistantUpdateParams {
 
   /**
    * Specifies the format that the model must output. Compatible with
-   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
-   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
    * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
@@ -1383,8 +1383,8 @@ export interface AssistantListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 

diff --git a/src/resources/beta/threads/messages.ts b/src/resources/beta/threads/messages.ts
@@ -704,8 +704,8 @@ export interface MessageListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 

diff --git a/src/resources/beta/threads/runs/runs.ts b/src/resources/beta/threads/runs/runs.ts
@@ -435,7 +435,7 @@ export interface Run {
 
   /**
    * Whether to enable
-   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling)
+   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
    * during tool use.
    */
   parallel_tool_calls: boolean;
@@ -448,8 +448,8 @@ export interface Run {
 
   /**
    * Specifies the format that the model must output. Compatible with
-   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
-   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
    * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
@@ -660,7 +660,7 @@ export interface RunCreateParamsBase {
    * search result content.
    *
    * See the
-   * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+   * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
    * for more information.
    */
   include?: Array<StepsAPI.RunStepInclude>;
@@ -721,15 +721,15 @@ export interface RunCreateParamsBase {
 
   /**
    * Body param: Whether to enable
-   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling)
+   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
    * during tool use.
    */
   parallel_tool_calls?: boolean;
 
   /**
    * Body param: Specifies the format that the model must output. Compatible with
-   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
-   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
    * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
@@ -909,8 +909,8 @@ export interface RunListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 

diff --git a/src/resources/beta/threads/runs/steps.ts b/src/resources/beta/threads/runs/steps.ts
@@ -705,7 +705,7 @@ export interface StepRetrieveParams {
    * to fetch the file search result content.
    *
    * See the
-   * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+   * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
    * for more information.
    */
   include?: Array<RunStepInclude>;
@@ -715,8 +715,8 @@ export interface StepListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 
@@ -726,7 +726,7 @@ export interface StepListParams extends CursorPageParams {
    * to fetch the file search result content.
    *
    * See the
-   * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+   * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
    * for more information.
    */
   include?: Array<RunStepInclude>;

diff --git a/src/resources/beta/threads/threads.ts b/src/resources/beta/threads/threads.ts
@@ -176,8 +176,8 @@ export class Threads extends APIResource {
 
 /**
  * Specifies the format that the model must output. Compatible with
- * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
- * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+ * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+ * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
  * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
  *
  * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
@@ -565,15 +565,15 @@ export interface ThreadCreateAndRunParamsBase {
 
   /**
    * Whether to enable
-   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling)
+   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
    * during tool use.
    */
   parallel_tool_calls?: boolean;
 
   /**
    * Specifies the format that the model must output. Compatible with
-   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
-   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
    * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured

diff --git a/src/resources/beta/vector-stores/file-batches.ts b/src/resources/beta/vector-stores/file-batches.ts
@@ -276,8 +276,8 @@ export interface FileBatchListFilesParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 

diff --git a/src/resources/beta/vector-stores/files.ts b/src/resources/beta/vector-stores/files.ts
@@ -268,8 +268,8 @@ export interface FileListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 

diff --git a/src/resources/beta/vector-stores/vector-stores.ts b/src/resources/beta/vector-stores/vector-stores.ts
@@ -372,8 +372,8 @@ export interface VectorStoreListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
    * in the list. For instance, if you make a list request and receive 100 objects,
-   * ending with obj_foo, your subsequent call can include before=obj_foo in order to
-   * fetch the previous page of the list.
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
    */
   before?: string;
 

diff --git a/src/resources/chat/chat.ts b/src/resources/chat/chat.ts
@@ -23,6 +23,7 @@ import {
   ChatCompletionMessageToolCall,
   ChatCompletionModality,
   ChatCompletionNamedToolChoice,
+  ChatCompletionPredictionContent,
   ChatCompletionRole,
   ChatCompletionStreamOptions,
   ChatCompletionSystemMessageParam,
@@ -101,6 +102,7 @@ export declare namespace Chat {
     type ChatCompletionMessageToolCall as ChatCompletionMessageToolCall,
     type ChatCompletionModality as ChatCompletionModality,
     type ChatCompletionNamedToolChoice as ChatCompletionNamedToolChoice,
+    type ChatCompletionPredictionContent as ChatCompletionPredictionContent,
     type ChatCompletionRole as ChatCompletionRole,
     type ChatCompletionStreamOptions as ChatCompletionStreamOptions,
     type ChatCompletionSystemMessageParam as ChatCompletionSystemMessageParam,