openai 7.12.1 → 7.13.0

package/src/resources/chat/completions/completions.ts

@@ -35,22 +35,22 @@ export class Completions extends APIResource {
 
   /**
    * **Starting a new project?** We recommend trying
-   * [Responses](https://platform.openai.com/docs/api-reference/responses) to take
-   * advantage of the latest OpenAI platform features. Compare
-   * [Chat Completions with Responses](https://platform.openai.com/docs/guides/responses-vs-chat-completions?api-mode=responses).
+   * [Responses](https://developers.openai.com/api/reference/resources/responses) to
+   * take advantage of the latest OpenAI platform features. Compare
+   * [Chat Completions with Responses](https://developers.openai.com/api/docs/guides/migrate-to-responses?api-mode=responses).
    *
    * ---
    *
    * Creates a model response for the given chat conversation. Learn more in the
-   * [text generation](https://platform.openai.com/docs/guides/text-generation),
-   * [vision](https://platform.openai.com/docs/guides/vision), and
-   * [audio](https://platform.openai.com/docs/guides/audio) guides.
+   * [text generation](https://developers.openai.com/api/docs/guides/text),
+   * [vision](https://developers.openai.com/api/docs/guides/images-vision), and
+   * [audio](https://developers.openai.com/api/docs/guides/audio) guides.
    *
    * Parameter support can differ depending on the model used to generate the
    * response, particularly for newer reasoning models. Parameters that are only
    * supported for reasoning models are noted below. For the current state of
    * unsupported parameters in reasoning models,
-   * [refer to the reasoning guide](https://platform.openai.com/docs/guides/reasoning).
+   * [refer to the reasoning guide](https://developers.openai.com/api/docs/guides/reasoning).
    *
    * Returns a chat completion object, or a streamed sequence of chat completion
    * chunk objects if the request is streamed.
@@ -383,13 +383,15 @@ export interface ChatCompletion {
    *   will use 'default'.
    * - If set to 'default', then the request will be processed with the standard
    *   pricing and performance for the selected model.
-   * - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
-   *   then the request will be processed with the Flex Processing service tier.
-   * - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
-   *   include the `service_tier=fast` or `service_tier=priority` parameter for
-   *   Responses or Chat Completions. The response will show `service_tier=priority`
-   *   regardless of if you specify `service_tier=fast` or `priority` in your
-   *   request.
+   * - If set to
+   *   '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+   *   the request will be processed with the Flex Processing service tier.
+   * - To opt-in to
+   *   [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+   *   request level, include the `service_tier=fast` or `service_tier=priority`
+   *   parameter for Responses or Chat Completions. The response will show
+   *   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+   *   `priority` in your request.
    * - When not set, the default behavior is 'auto'.
    *
    * When the `service_tier` parameter is set, the response body will include the
@@ -663,7 +665,7 @@ export interface ChatCompletionAssistantMessageParam {
 
   /**
    * Data about a previous audio response from the model.
-   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   * [Learn more](https://developers.openai.com/api/docs/guides/audio).
    */
   audio?: ChatCompletionAssistantMessageParam.Audio | null;
 
@@ -699,7 +701,7 @@ export interface ChatCompletionAssistantMessageParam {
 export namespace ChatCompletionAssistantMessageParam {
   /**
    * Data about a previous audio response from the model.
-   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   * [Learn more](https://developers.openai.com/api/docs/guides/audio).
    */
   export interface Audio {
     /**
@@ -731,7 +733,7 @@ export namespace ChatCompletionAssistantMessageParam {
 /**
  * If the audio output modality is requested, this object contains data about the
  * audio response from the model.
- * [Learn more](https://platform.openai.com/docs/guides/audio).
+ * [Learn more](https://developers.openai.com/api/docs/guides/audio).
  */
 export interface ChatCompletionAudio {
   /**
@@ -760,7 +762,7 @@ export interface ChatCompletionAudio {
 /**
  * Parameters for audio output. Required when audio output is requested with
  * `modalities: ["audio"]`.
- * [Learn more](https://platform.openai.com/docs/guides/audio).
+ * [Learn more](https://developers.openai.com/api/docs/guides/audio).
  */
 export interface ChatCompletionAudioParam {
   /**
@@ -805,7 +807,7 @@ export namespace ChatCompletionAudioParam {
 /**
  * Represents a streamed chunk of a chat completion response returned by the model,
  * based on the provided input.
- * [Learn more](https://platform.openai.com/docs/guides/streaming-responses).
+ * [Learn more](https://developers.openai.com/api/docs/guides/streaming-responses).
  */
 export interface ChatCompletionChunk {
   /**
@@ -857,13 +859,15 @@ export interface ChatCompletionChunk {
    *   will use 'default'.
    * - If set to 'default', then the request will be processed with the standard
    *   pricing and performance for the selected model.
-   * - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
-   *   then the request will be processed with the Flex Processing service tier.
-   * - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
-   *   include the `service_tier=fast` or `service_tier=priority` parameter for
-   *   Responses or Chat Completions. The response will show `service_tier=priority`
-   *   regardless of if you specify `service_tier=fast` or `priority` in your
-   *   request.
+   * - If set to
+   *   '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+   *   the request will be processed with the Flex Processing service tier.
+   * - To opt-in to
+   *   [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+   *   request level, include the `service_tier=fast` or `service_tier=priority`
+   *   parameter for Responses or Chat Completions. The response will show
+   *   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+   *   `priority` in your request.
    * - When not set, the default behavior is 'auto'.
    *
    * When the `service_tier` parameter is set, the response body will include the
@@ -1211,8 +1215,7 @@ export namespace ChatCompletionChunk {
 }
 
 /**
- * Learn about
- * [text inputs](https://platform.openai.com/docs/guides/text-generation).
+ * Learn about [text inputs](https://developers.openai.com/api/docs/guides/text).
  */
 export type ChatCompletionContentPart =
   | ChatCompletionContentPartText
@@ -1222,8 +1225,8 @@ export type ChatCompletionContentPart =
 
 export namespace ChatCompletionContentPart {
   /**
-   * Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text
-   * generation.
+   * Learn about [file inputs](https://developers.openai.com/api/docs/guides/text)
+   * for text generation.
    */
   export interface File {
     file: File.File;
@@ -1275,7 +1278,8 @@ export namespace ChatCompletionContentPart {
 }
 
 /**
- * Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+ * Learn about
+ * [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
  */
 export interface ChatCompletionContentPartImage {
   image_url: ChatCompletionContentPartImage.ImageURL;
@@ -1302,7 +1306,7 @@ export namespace ChatCompletionContentPartImage {
 
     /**
      * Specifies the detail level of the image. Learn more in the
-     * [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding).
+     * [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
      */
     detail?: 'auto' | 'low' | 'high';
   }
@@ -1321,7 +1325,7 @@ export namespace ChatCompletionContentPartImage {
 }
 
 /**
- * Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).
+ * Learn about [audio inputs](https://developers.openai.com/api/docs/guides/audio).
  */
 export interface ChatCompletionContentPartInputAudio {
   input_audio: ChatCompletionContentPartInputAudio.InputAudio;
@@ -1378,8 +1382,7 @@ export interface ChatCompletionContentPartRefusal {
 }
 
 /**
- * Learn about
- * [text inputs](https://platform.openai.com/docs/guides/text-generation).
+ * Learn about [text inputs](https://developers.openai.com/api/docs/guides/text).
  */
 export interface ChatCompletionContentPartText {
   /**
@@ -1599,14 +1602,14 @@ export interface ChatCompletionMessage {
 
   /**
    * Annotations for the message, when applicable, as when using the
-   * [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+   * [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
    */
   annotations?: Array<ChatCompletionMessage.Annotation>;
 
   /**
    * If the audio output modality is requested, this object contains data about the
    * audio response from the model.
-   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   * [Learn more](https://developers.openai.com/api/docs/guides/audio).
    */
   audio?: ChatCompletionAudio | null;
 
@@ -2070,11 +2073,11 @@ export type ChatCompletionCreateParams =
 export interface ChatCompletionCreateParamsBase {
   /**
    * A list of messages comprising the conversation so far. Depending on the
-   * [model](https://platform.openai.com/docs/models) you use, different message
-   * types (modalities) are supported, like
-   * [text](https://platform.openai.com/docs/guides/text-generation),
-   * [images](https://platform.openai.com/docs/guides/vision), and
-   * [audio](https://platform.openai.com/docs/guides/audio).
+   * [model](https://developers.openai.com/api/docs/models) you use, different
+   * message types (modalities) are supported, like
+   * [text](https://developers.openai.com/api/docs/guides/text),
+   * [images](https://developers.openai.com/api/docs/guides/images-vision), and
+   * [audio](https://developers.openai.com/api/docs/guides/audio).
    */
   messages: Array<ChatCompletionMessageParam>;
 
@@ -2082,15 +2085,15 @@ export interface ChatCompletionCreateParamsBase {
    * Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI
    * offers a wide range of models with different capabilities, performance
    * characteristics, and price points. Refer to the
-   * [model guide](https://platform.openai.com/docs/models) to browse and compare
-   * available models.
+   * [model guide](https://developers.openai.com/api/docs/models) to browse and
+   * compare available models.
    */
   model: (string & {}) | Shared.ChatModel;
 
   /**
    * Parameters for audio output. Required when audio output is requested with
    * `modalities: ["audio"]`.
-   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   * [Learn more](https://developers.openai.com/api/docs/guides/audio).
    */
   audio?: ChatCompletionAudioParam | null;
 
@@ -2148,18 +2151,19 @@ export interface ChatCompletionCreateParamsBase {
   /**
    * An upper bound for the number of tokens that can be generated for a completion,
    * including visible output tokens and
-   * [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
+   * [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
    */
   max_completion_tokens?: number | null;
 
   /**
-   * @deprecated The maximum number of [tokens](/tokenizer) that can be generated in
-   * the chat completion. This value can be used to control
+   * @deprecated The maximum number of
+   * [tokens](https://platform.openai.com/tokenizer) that can be generated in the
+   * chat completion. This value can be used to control
    * [costs](https://openai.com/api/pricing/) for text generated via API.
    *
    * This value is now deprecated in favor of `max_completion_tokens`, and is not
    * compatible with
-   * [o-series models](https://platform.openai.com/docs/guides/reasoning).
+   * [o-series models](https://developers.openai.com/api/docs/guides/reasoning).
    */
   max_tokens?: number | null;
 
@@ -2180,8 +2184,8 @@ export interface ChatCompletionCreateParamsBase {
    * `["text"]`
    *
    * The `gpt-4o-audio-preview` model can also be used to
-   * [generate audio](https://platform.openai.com/docs/guides/audio). To request that
-   * this model generate both text and audio responses, you can use:
+   * [generate audio](https://developers.openai.com/api/docs/guides/audio). To
+   * request that this model generate both text and audio responses, you can use:
    *
    * `["text", "audio"]`
    */
@@ -2201,7 +2205,7 @@ export interface ChatCompletionCreateParamsBase {
 
   /**
    * 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;
@@ -2222,7 +2226,7 @@ export interface ChatCompletionCreateParamsBase {
   /**
    * Used by OpenAI to cache responses for similar requests to optimize your cache
    * hit rates. Replaces the `user` field.
-   * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+   * [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
    */
   prompt_cache_key?: string | null;
 
@@ -2234,7 +2238,7 @@ export interface ChatCompletionCreateParamsBase {
    * up to the latest 80 breakpoints in the conversation, without a content-block
    * lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
    * `ttl` defaults to `30m`, which is currently the only supported value. See the
-   * [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
+   * [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
    * for current details.
    */
   prompt_cache_options?: ChatCompletionCreateParams.PromptCacheOptions;
@@ -2245,7 +2249,7 @@ export interface ChatCompletionCreateParamsBase {
    * The retention policy for the prompt cache. Set to `24h` to enable extended
    * prompt caching, which keeps cached prefixes active for longer, up to a maximum
    * of 24 hours.
-   * [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+   * [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
    * This field expresses a maximum retention policy, while
    * `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
    * are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
@@ -2265,7 +2269,7 @@ export interface ChatCompletionCreateParamsBase {
    * 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
+   * [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
    * model-specific support.
    */
   reasoning_effort?: Shared.ReasoningEffort | null;
@@ -2276,7 +2280,7 @@ export interface ChatCompletionCreateParamsBase {
    * 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 the older JSON mode, which
    * ensures the message the model generates is valid JSON. Using `json_schema` is
@@ -2293,7 +2297,7 @@ export interface ChatCompletionCreateParamsBase {
    * identifies each user, with a maximum length of 64 characters. We recommend
    * hashing their username or email address, in order to avoid sending us any
    * identifying information.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+   * [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
    */
   safety_identifier?: string | null;
 
@@ -2314,13 +2318,15 @@ export interface ChatCompletionCreateParamsBase {
    *   will use 'default'.
    * - If set to 'default', then the request will be processed with the standard
    *   pricing and performance for the selected model.
-   * - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
-   *   then the request will be processed with the Flex Processing service tier.
-   * - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
-   *   include the `service_tier=fast` or `service_tier=priority` parameter for
-   *   Responses or Chat Completions. The response will show `service_tier=priority`
-   *   regardless of if you specify `service_tier=fast` or `priority` in your
-   *   request.
+   * - If set to
+   *   '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+   *   the request will be processed with the Flex Processing service tier.
+   * - To opt-in to
+   *   [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+   *   request level, include the `service_tier=fast` or `service_tier=priority`
+   *   parameter for Responses or Chat Completions. The response will show
+   *   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+   *   `priority` in your request.
    * - When not set, the default behavior is 'auto'.
    *
    * When the `service_tier` parameter is set, the response body will include the
@@ -2340,8 +2346,9 @@ export interface ChatCompletionCreateParamsBase {
 
   /**
    * Whether or not to store the output of this chat completion request for use in
-   * our [model distillation](https://platform.openai.com/docs/guides/distillation)
-   * or [evals](https://platform.openai.com/docs/guides/evals) products.
+   * our
+   * [model distillation](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#distilling-from-a-larger-model)
+   * or [evals](https://developers.openai.com/api/docs/guides/evals) products.
    *
    * Supports text and image inputs. Note: image inputs over 8MB will be dropped.
    */
@@ -2352,9 +2359,9 @@ export interface ChatCompletionCreateParamsBase {
    * generated using
    * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
    * See the
-   * [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
+   * [Streaming section below](https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events)
    * for more information, along with the
-   * [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
+   * [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses)
    * guide for more information on how to handle the streaming events.
    */
   stream?: boolean | null;
@@ -2387,8 +2394,9 @@ export interface ChatCompletionCreateParamsBase {
 
   /**
    * A list of tools the model may call. You can provide either
-   * [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
-   * or [function tools](https://platform.openai.com/docs/guides/function-calling).
+   * [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
+   * or
+   * [function tools](https://developers.openai.com/api/docs/guides/function-calling).
    */
   tools?: Array<ChatCompletionTool>;
 
@@ -2415,7 +2423,7 @@ export interface ChatCompletionCreateParamsBase {
    * optimizations. A stable identifier for your end-users. Used to boost cache hit
    * rates by better bucketing similar requests and to help OpenAI detect and prevent
    * abuse.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+   * [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
    */
   user?: string;
 
@@ -2430,7 +2438,7 @@ export interface ChatCompletionCreateParamsBase {
   /**
    * This tool searches the web for relevant results to use in a response. Learn more
    * about the
-   * [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+   * [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
    */
   web_search_options?: ChatCompletionCreateParams.WebSearchOptions;
 }
@@ -2454,8 +2462,8 @@ export namespace ChatCompletionCreateParams {
 
     /**
      * The parameters the functions accepts, described as a JSON Schema object. See the
-     * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
-     * and the
+     * [guide](https://developers.openai.com/api/docs/guides/function-calling) for
+     * examples, and the
      * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
      * documentation about the format.
      *
@@ -2521,7 +2529,7 @@ export namespace ChatCompletionCreateParams {
    * up to the latest 80 breakpoints in the conversation, without a content-block
    * lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
    * `ttl` defaults to `30m`, which is currently the only supported value. See the
-   * [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching)
+   * [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
    * for current details.
    */
   export interface PromptCacheOptions {
@@ -2546,7 +2554,7 @@ export namespace ChatCompletionCreateParams {
   /**
    * This tool searches the web for relevant results to use in a response. Learn more
    * about the
-   * [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+   * [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
    */
   export interface WebSearchOptions {
     /**
@@ -2618,9 +2626,9 @@ export interface ChatCompletionCreateParamsNonStreaming extends ChatCompletionCr
    * generated using
    * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
    * See the
-   * [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
+   * [Streaming section below](https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events)
    * for more information, along with the
-   * [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
+   * [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses)
    * guide for more information on how to handle the streaming events.
    */
   stream?: false | null;
@@ -2632,9 +2640,9 @@ export interface ChatCompletionCreateParamsStreaming extends ChatCompletionCreat
    * generated using
    * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
    * See the
-   * [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
+   * [Streaming section below](https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events)
    * for more information, along with the
-   * [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
+   * [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses)
    * guide for more information on how to handle the streaming events.
    */
   stream: true;

package/src/resources/completions.ts

@@ -217,10 +217,10 @@ export type CompletionCreateParams = CompletionCreateParamsNonStreaming | Comple
 export interface CompletionCreateParamsBase {
   /**
    * 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) for descriptions of
-   * them.
+   * [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+   * API to see all of your available models, or see our
+   * [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+   * of them.
    */
   model: (string & {}) | 'gpt-3.5-turbo-instruct' | 'davinci-002' | 'babbage-002';
 
@@ -257,7 +257,7 @@ export interface CompletionCreateParamsBase {
    * existing frequency in the text so far, decreasing the model's likelihood to
    * repeat the same line verbatim.
    *
-   * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+   * [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
    */
   frequency_penalty?: number | null;
 
@@ -266,11 +266,12 @@ export interface CompletionCreateParamsBase {
    *
    * Accepts a JSON object that maps tokens (specified by their token ID in the GPT
    * tokenizer) to an associated bias value from -100 to 100. You can use this
-   * [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
-   * Mathematically, the bias is added to the logits generated by the model prior to
-   * sampling. The exact effect will vary per model, but values between -1 and 1
-   * should decrease or increase likelihood of selection; values like -100 or 100
-   * should result in a ban or exclusive selection of the relevant token.
+   * [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text
+   * to token IDs. Mathematically, the bias is added to the logits generated by the
+   * model prior to sampling. The exact effect will vary per model, but values
+   * between -1 and 1 should decrease or increase likelihood of selection; values
+   * like -100 or 100 should result in a ban or exclusive selection of the relevant
+   * token.
    *
    * As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
    * from being generated.
@@ -288,8 +289,8 @@ export interface CompletionCreateParamsBase {
   logprobs?: number | null;
 
   /**
-   * The maximum number of [tokens](/tokenizer) that can be generated in the
-   * completion.
+   * The maximum number of [tokens](https://platform.openai.com/tokenizer) that can
+   * be generated in the completion.
    *
    * The token count of your prompt plus `max_tokens` cannot exceed the model's
    * context length.
@@ -312,7 +313,7 @@ export interface CompletionCreateParamsBase {
    * whether they appear in the text so far, increasing the model's likelihood to
    * talk about new topics.
    *
-   * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+   * [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)
    */
   presence_penalty?: number | null;
 
@@ -377,7 +378,7 @@ export interface CompletionCreateParamsBase {
   /**
    * A unique identifier representing your end-user, which can help OpenAI to monitor
    * and detect abuse.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+   * [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
    */
   user?: string;
 }

package/src/resources/content-provenance-checks.ts

@@ -9,7 +9,7 @@ import { multipartFormRequestOptions } from '../internal/uploads';
 export class ContentProvenanceChecks extends APIResource {
   /**
    * Check whether an image or audio file contains known OpenAI provenance signals.
-   * [Learn more about content provenance](/api/docs/guides/content-provenance).
+   * [Learn more about content provenance](https://developers.openai.com/api/docs/guides/content-provenance).
    *
    * If `not_detected`, it means the tool did not find supported signals in the
    * uploaded file. The content could still have been generated by OpenAI if the

package/src/resources/conversations/items.ts

@@ -85,7 +85,7 @@ export type ConversationItemsPage = ConversationCursorPage<ConversationItem>;
 /**
  * A single item within a conversation. The set of possible types are the same as
  * the `output` type of a
- * [Response object](https://platform.openai.com/docs/api-reference/responses/object#responses/object-output).
+ * [Response object](https://developers.openai.com/api/reference/resources/responses#%28resource%29%20responses%20%3E%20%28model%29%20response%20%3E%20%28schema%29%20%3E%20%28property%29%20output).
  */
 export type ConversationItem =
   | ConversationsAPI.Message
@@ -534,7 +534,7 @@ export interface ItemCreateParams {
   /**
    * Query param: Additional fields to include in the response. See the `include`
    * parameter for
-   * [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+   * [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
    * for more information.
    */
   include?: Array<ResponsesAPI.ResponseIncludable>;
@@ -549,7 +549,7 @@ export interface ItemRetrieveParams {
   /**
    * Query param: Additional fields to include in the response. See the `include`
    * parameter for
-   * [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+   * [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
    * for more information.
    */
   include?: Array<ResponsesAPI.ResponseIncludable>;

package/src/resources/embeddings.ts

@@ -84,7 +84,7 @@ export interface Embedding {
   /**
    * The embedding vector, which is a list of floats. The length of vector depends on
    * the model as listed in the
-   * [embedding guide](https://platform.openai.com/docs/guides/embeddings).
+   * [embedding guide](https://developers.openai.com/api/docs/guides/embeddings).
    */
   embedding: Array<number>;
 
@@ -117,10 +117,10 @@ export interface EmbeddingCreateParams {
 
   /**
    * 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) for descriptions of
-   * them.
+   * [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+   * API to see all of your available models, or see our
+   * [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+   * of them.
    */
   model: (string & {}) | EmbeddingModel;
 
@@ -139,7 +139,7 @@ export interface EmbeddingCreateParams {
   /**
    * A unique identifier representing your end-user, which can help OpenAI to monitor
    * and detect abuse.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+   * [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
    */
   user?: string;
 }

package/src/resources/evals/evals.ts

@@ -39,7 +39,7 @@ export class Evals extends APIResource {
    * data source, which dictates the schema of the data used in the evaluation. After
    * creating an evaluation, you can run it on different models and model parameters.
    * We support several types of graders and datasources. For more information, see
-   * the [Evals guide](https://platform.openai.com/docs/guides/evals).
+   * the [Evals guide](https://developers.openai.com/api/docs/guides/evals).
    */
   create(body: EvalCreateParams, options?: RequestOptions): APIPromise<EvalCreateResponse> {
     return this._client.post('/evals', { body, ...options, __security: { bearerAuth: true } });