openai 7.10.0 → 7.13.0

package/src/resources/beta/threads/messages.ts

@@ -254,9 +254,9 @@ export namespace FilePathDeltaAnnotation {
 
 export interface ImageFile {
   /**
-   * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
-   * in the message content. Set `purpose="vision"` when uploading the File if you
-   * need to later display the file content.
+   * The [File](https://developers.openai.com/api/reference/resources/files) ID of
+   * the image in the message content. Set `purpose="vision"` when uploading the File
+   * if you need to later display the file content.
    */
   file_id: string;
 
@@ -268,8 +268,9 @@ export interface ImageFile {
 }
 
 /**
- * References an image [File](https://platform.openai.com/docs/api-reference/files)
- * in the content of a message.
+ * References an image
+ * [File](https://developers.openai.com/api/reference/resources/files) in the
+ * content of a message.
  */
 export interface ImageFileContentBlock {
   image_file: ImageFile;
@@ -288,16 +289,17 @@ export interface ImageFileDelta {
   detail?: 'auto' | 'low' | 'high';
 
   /**
-   * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
-   * in the message content. Set `purpose="vision"` when uploading the File if you
-   * need to later display the file content.
+   * The [File](https://developers.openai.com/api/reference/resources/files) ID of
+   * the image in the message content. Set `purpose="vision"` when uploading the File
+   * if you need to later display the file content.
    */
   file_id?: string;
 }
 
 /**
- * References an image [File](https://platform.openai.com/docs/api-reference/files)
- * in the content of a message.
+ * References an image
+ * [File](https://developers.openai.com/api/reference/resources/files) in the
+ * content of a message.
  */
 export interface ImageFileDeltaBlock {
   /**
@@ -372,7 +374,7 @@ export interface ImageURLDeltaBlock {
 
 /**
  * Represents a message within a
- * [thread](https://platform.openai.com/docs/api-reference/threads).
+ * [thread](https://developers.openai.com/api/docs/assistants/migration).
  */
 export interface Message {
   /**
@@ -382,7 +384,7 @@ export interface Message {
 
   /**
    * If applicable, the ID of the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) that
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) that
    * authored this message.
    */
   assistant_id: string | null;
@@ -438,7 +440,7 @@ export interface Message {
   role: 'user' | 'assistant';
 
   /**
-   * The ID of the [run](https://platform.openai.com/docs/api-reference/runs)
+   * The ID of the [run](https://developers.openai.com/api/docs/assistants/migration)
    * associated with the creation of this message. Value is `null` when messages are
    * created manually using the create message or create thread endpoints.
    */
@@ -451,8 +453,8 @@ export interface Message {
   status: 'in_progress' | 'incomplete' | 'completed';
 
   /**
-   * The [thread](https://platform.openai.com/docs/api-reference/threads) ID that
-   * this message belongs to.
+   * The [thread](https://developers.openai.com/api/docs/assistants/migration) ID
+   * that this message belongs to.
    */
   thread_id: string;
 }
@@ -491,8 +493,9 @@ export namespace Message {
 }
 
 /**
- * References an image [File](https://platform.openai.com/docs/api-reference/files)
- * in the content of a message.
+ * References an image
+ * [File](https://developers.openai.com/api/reference/resources/files) in the
+ * content of a message.
  */
 export type MessageContent =
   | ImageFileContentBlock
@@ -501,8 +504,9 @@ export type MessageContent =
   | RefusalContentBlock;
 
 /**
- * References an image [File](https://platform.openai.com/docs/api-reference/files)
- * in the content of a message.
+ * References an image
+ * [File](https://developers.openai.com/api/reference/resources/files) in the
+ * content of a message.
  */
 export type MessageContentDelta =
   | ImageFileDeltaBlock
@@ -511,8 +515,9 @@ export type MessageContentDelta =
   | ImageURLDeltaBlock;
 
 /**
- * References an image [File](https://platform.openai.com/docs/api-reference/files)
- * in the content of a message.
+ * References an image
+ * [File](https://developers.openai.com/api/reference/resources/files) in the
+ * content of a message.
  */
 export type MessageContentPartParam = ImageFileContentBlock | ImageURLContentBlock | TextContentBlockParam;
 
@@ -708,8 +713,9 @@ export namespace MessageCreateParams {
 
 export interface MessageRetrieveParams {
   /**
-   * The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
-   * to which this message belongs.
+   * The ID of the
+   * [thread](https://developers.openai.com/api/docs/assistants/migration) to which
+   * this message belongs.
    */
   thread_id: string;
 }

package/src/resources/beta/threads/runs/runs.ts

@@ -266,7 +266,7 @@ export interface RequiredActionFunctionToolCall {
   /**
    * The ID of the tool call. This ID must be referenced when you submit the tool
    * outputs in using the
-   * [Submit tool outputs to run](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)
+   * [Submit tool outputs to run](https://developers.openai.com/api/docs/assistants/migration)
    * endpoint.
    */
   id: string;
@@ -302,7 +302,7 @@ export namespace RequiredActionFunctionToolCall {
 
 /**
  * Represents an execution run on a
- * [thread](https://platform.openai.com/docs/api-reference/threads).
+ * [thread](https://developers.openai.com/api/docs/assistants/migration).
  */
 export interface Run {
   /**
@@ -312,8 +312,8 @@ export interface Run {
 
   /**
    * The ID of the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
-   * execution of this run.
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) used
+   * for execution of this run.
    */
   assistant_id: string;
 
@@ -350,8 +350,8 @@ export interface Run {
 
   /**
    * The instructions that the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
-   * this run.
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) used
+   * for this run.
    */
   instructions: string;
 
@@ -384,8 +384,8 @@ export interface Run {
 
   /**
    * The model that the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
-   * this run.
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) used
+   * for this run.
    */
   model: string;
 
@@ -396,7 +396,7 @@ export interface Run {
 
   /**
    * Whether to enable
-   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
+   * [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
    * during tool use.
    */
   parallel_tool_calls: boolean;
@@ -409,14 +409,14 @@ 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),
-   * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+   * [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+   * [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+   * all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
    * Outputs which ensures the model will match your supplied JSON schema. Learn more
    * in the
-   * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+   * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
    *
    * Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
    * message the model generates is valid JSON.
@@ -444,8 +444,9 @@ export interface Run {
   status: RunStatus;
 
   /**
-   * The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
-   * that was executed on as a part of this run.
+   * The ID of the
+   * [thread](https://developers.openai.com/api/docs/assistants/migration) that was
+   * executed on as a part of this run.
    */
   thread_id: string;
 
@@ -462,8 +463,8 @@ export interface Run {
 
   /**
    * The list of tools that the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
-   * this run.
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) used
+   * for this run.
    */
   tools: Array<AssistantsAPI.AssistantTool>;
 
@@ -609,8 +610,8 @@ export type RunCreateParams = RunCreateParamsNonStreaming | RunCreateParamsStrea
 export interface RunCreateParamsBase {
   /**
    * Body param: The ID of the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
-   * execute this run.
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
+   * to execute this run.
    */
   assistant_id: string;
 
@@ -621,7 +622,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://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
    * for more information.
    */
   include?: Array<StepsAPI.RunStepInclude>;
@@ -640,8 +641,8 @@ export interface RunCreateParamsBase {
 
   /**
    * Body param: Overrides the
-   * [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant)
-   * of the assistant. This is useful for modifying the behavior on a per-run basis.
+   * [instructions](https://developers.openai.com/api/docs/assistants/migration) of
+   * the assistant. This is useful for modifying the behavior on a per-run basis.
    */
   instructions?: string | null;
 
@@ -675,8 +676,8 @@ export interface RunCreateParamsBase {
 
   /**
    * Body param: The ID of the
-   * [Model](https://platform.openai.com/docs/api-reference/models) to be used to
-   * execute this run. If a value is provided here, it will override the model
+   * [Model](https://developers.openai.com/api/reference/resources/models) 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.
    */
@@ -684,7 +685,7 @@ export interface RunCreateParamsBase {
 
   /**
    * Body param: Whether to enable
-   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
+   * [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
    * during tool use.
    */
   parallel_tool_calls?: boolean;
@@ -694,21 +695,22 @@ export interface RunCreateParamsBase {
    * supported values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and
    * `max`. Reducing reasoning effort can result in faster responses and fewer tokens
    * used on reasoning in a response. Not all reasoning models support every value.
-   * See the [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+   * See the
+   * [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
    * model-specific support.
    */
   reasoning_effort?: Shared.ReasoningEffort | null;
 
   /**
    * 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),
-   * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+   * [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+   * [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+   * all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
    *
    * Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
    * Outputs which ensures the model will match your supplied JSON schema. Learn more
    * in the
-   * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+   * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
    *
    * Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
    * message the model generates is valid JSON.
@@ -872,8 +874,9 @@ export interface RunCreateParamsStreaming extends RunCreateParamsBase {
 
 export interface RunRetrieveParams {
   /**
-   * The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
-   * that was run.
+   * The ID of the
+   * [thread](https://developers.openai.com/api/docs/assistants/migration) that was
+   * run.
    */
   thread_id: string;
 }
@@ -881,7 +884,8 @@ export interface RunRetrieveParams {
 export interface RunUpdateParams {
   /**
    * Path param: The ID of the
-   * [thread](https://platform.openai.com/docs/api-reference/threads) that was run.
+   * [thread](https://developers.openai.com/api/docs/assistants/migration) that was
+   * run.
    */
   thread_id: string;
 
@@ -932,8 +936,8 @@ export type RunSubmitToolOutputsParams =
 export interface RunSubmitToolOutputsParamsBase {
   /**
    * Path param: The ID of the
-   * [thread](https://platform.openai.com/docs/api-reference/threads) to which this
-   * run belongs.
+   * [thread](https://developers.openai.com/api/docs/assistants/migration) to which
+   * this run belongs.
    */
   thread_id: string;
 

package/src/resources/beta/threads/runs/steps.ts

@@ -85,8 +85,8 @@ export interface CodeInterpreterOutputImage {
 export namespace CodeInterpreterOutputImage {
   export interface Image {
     /**
-     * The [file](https://platform.openai.com/docs/api-reference/files) ID of the
-     * image.
+     * The [file](https://developers.openai.com/api/reference/resources/files) ID of
+     * the image.
      */
     file_id?: string;
   }
@@ -159,8 +159,8 @@ export namespace CodeInterpreterToolCall {
     export namespace Image {
       export interface Image {
         /**
-         * The [file](https://platform.openai.com/docs/api-reference/files) ID of the
-         * image.
+         * The [file](https://developers.openai.com/api/reference/resources/files) ID of
+         * the image.
          */
         file_id: string;
       }
@@ -366,8 +366,7 @@ export namespace FunctionToolCall {
 
     /**
      * The output of the function. This will be `null` if the outputs have not been
-     * [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)
-     * yet.
+     * [submitted](https://developers.openai.com/api/docs/assistants/migration) yet.
      */
     output: string | null;
   }
@@ -413,8 +412,7 @@ export namespace FunctionToolCallDelta {
 
     /**
      * The output of the function. This will be `null` if the outputs have not been
-     * [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)
-     * yet.
+     * [submitted](https://developers.openai.com/api/docs/assistants/migration) yet.
      */
     output?: string | null;
   }
@@ -452,7 +450,7 @@ export interface RunStep {
 
   /**
    * The ID of the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants)
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration)
    * associated with the run step.
    */
   assistant_id: string;
@@ -505,8 +503,8 @@ export interface RunStep {
   object: 'thread.run.step';
 
   /**
-   * The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that
-   * this run step is a part of.
+   * The ID of the [run](https://developers.openai.com/api/docs/assistants/migration)
+   * that this run step is a part of.
    */
   run_id: string;
 
@@ -522,8 +520,9 @@ export interface RunStep {
   step_details: MessageCreationStepDetails | ToolCallsStepDetails;
 
   /**
-   * The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
-   * that was run.
+   * The ID of the
+   * [thread](https://developers.openai.com/api/docs/assistants/migration) that was
+   * run.
    */
   thread_id: string;
 
@@ -694,7 +693,7 @@ export interface StepRetrieveParams {
    * 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://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
    * for more information.
    */
   include?: Array<RunStepInclude>;
@@ -721,7 +720,7 @@ export interface StepListParams extends CursorPageParams {
    * 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://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
    * for more information.
    */
   include?: Array<RunStepInclude>;