chore(api): docs and spec refactoring

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-94b1e3cb0bdc616ff0c2f267c33dadd95f133b1f64e647aab6c64afb292b2793.yml
-openapi_spec_hash: 2395319ac9befd59b6536ae7f9564a05
-config_hash: 930dac3aa861344867e4ac84f037b5df
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d30ff992a48873c1466c49f3c01f2ec8933faebff23424748f8d056065b1bcef.yml
+openapi_spec_hash: e933ec43b46f45c348adb78840e5808d
+config_hash: bf45940f0a7805b4ec2017eecdd36893

src/resources/chat/completions/completions.ts

@@ -1946,9 +1946,12 @@ export interface ChatCompletionUpdateParams {
 
 export interface ChatCompletionListParams extends CursorPageParams {
   /**
-   * A list of metadata keys to filter the Chat Completions by. Example:
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard.
    *
-   * `metadata[key1]=value1&metadata[key2]=value2`
+   * Keys are strings with a maximum length of 64 characters. Values are strings with
+   * a maximum length of 512 characters.
    */
   metadata?: Shared.Metadata | null;
 

src/resources/conversations/conversations.ts

@@ -361,8 +361,12 @@ export interface ConversationCreateParams {
   items?: Array<ResponsesAPI.ResponseInputItem> | null;
 
   /**
-   * Set of 16 key-value pairs that can be attached to an object. Useful for storing
-   * additional information about the object in a structured format.
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard.
+   *
+   * Keys are strings with a maximum length of 64 characters. Values are strings with
+   * a maximum length of 512 characters.
    */
   metadata?: Shared.Metadata | null;
 }

src/resources/evals/runs/runs.ts

@@ -578,8 +578,11 @@ export namespace RunCreateResponse {
       model?: string | null;
 
       /**
-       * Optional reasoning effort parameter. This is a query parameter used to select
-       * responses.
+       * Constrains effort on reasoning for
+       * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
+       * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+       * effort can result in faster responses and fewer tokens used on reasoning in a
+       * response.
        */
       reasoning_effort?: Shared.ReasoningEffort | null;
 
@@ -1052,8 +1055,11 @@ export namespace RunRetrieveResponse {
       model?: string | null;
 
       /**
-       * Optional reasoning effort parameter. This is a query parameter used to select
-       * responses.
+       * Constrains effort on reasoning for
+       * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
+       * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+       * effort can result in faster responses and fewer tokens used on reasoning in a
+       * response.
        */
       reasoning_effort?: Shared.ReasoningEffort | null;
 
@@ -1523,8 +1529,11 @@ export namespace RunListResponse {
       model?: string | null;
 
       /**
-       * Optional reasoning effort parameter. This is a query parameter used to select
-       * responses.
+       * Constrains effort on reasoning for
+       * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
+       * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+       * effort can result in faster responses and fewer tokens used on reasoning in a
+       * response.
        */
       reasoning_effort?: Shared.ReasoningEffort | null;
 
@@ -2005,8 +2014,11 @@ export namespace RunCancelResponse {
       model?: string | null;
 
       /**
-       * Optional reasoning effort parameter. This is a query parameter used to select
-       * responses.
+       * Constrains effort on reasoning for
+       * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
+       * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+       * effort can result in faster responses and fewer tokens used on reasoning in a
+       * response.
        */
       reasoning_effort?: Shared.ReasoningEffort | null;
 
@@ -2426,8 +2438,11 @@ export namespace RunCreateParams {
       model?: string | null;
 
       /**
-       * Optional reasoning effort parameter. This is a query parameter used to select
-       * responses.
+       * Constrains effort on reasoning for
+       * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
+       * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+       * effort can result in faster responses and fewer tokens used on reasoning in a
+       * response.
        */
       reasoning_effort?: Shared.ReasoningEffort | null;