openai 7.19.0 → 7.20.0

package/src/resources/beta/agents/agents.ts

@@ -31,6 +31,113 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+// Recognizable options across SDK runtime versions. Keep this independent of
+// private RequestOptions fields so older handwritten runtimes still compile.
+const normalizeRequestOptionsForQueryKeys = new Set([
+  'method',
+  'path',
+  'query',
+  'body',
+  'headers',
+  'maxRetries',
+  'stream',
+  'timeout',
+  'httpAgent',
+  'fetchOptions',
+  'signal',
+  'idempotencyKey',
+  'defaultBaseURL',
+  '__metadata',
+  '__binaryRequest',
+  '__binaryResponse',
+  '__streamClass',
+  '__security',
+  '__synthesizeEventData',
+]);
+
+function normalizeRequestOptionsForQuery(
+  value: unknown,
+  queryKeys: ReadonlyArray<string>,
+  options: RequestOptions | undefined,
+):
+  | ({
+      [K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query']?: RequestOptions[K];
+    } & {
+      [
+        K in
+          | 'method'
+          | 'path'
+          | 'body'
+          | 'stream'
+          | 'httpAgent'
+          | 'fetchOptions'
+          | 'defaultBaseURL'
+          | '__metadata'
+          | '__binaryRequest'
+          | '__binaryResponse'
+          | '__streamClass'
+          | '__security'
+          | '__synthesizeEventData'
+      ]?: never;
+    })
+  | undefined {
+  if (typeof value !== 'object' || value === null) return undefined;
+  // Optional never fields can still be explicitly undefined unless consumers
+  // enable exactOptionalPropertyTypes. Snapshot data without invoking getters.
+  const entries = Object.entries(Object.getOwnPropertyDescriptors(value)).filter(
+    ([, descriptor]) => descriptor.enumerable && (!('value' in descriptor) || descriptor.value !== undefined),
+  );
+  const keys = entries.map(([key]) => key);
+  const requestOnly = keys.some(
+    (key) => normalizeRequestOptionsForQueryKeys.has(key) && !queryKeys.includes(key),
+  );
+  if (!requestOnly) return undefined;
+  // Declared query fields, including stream, must use the query argument.
+  // Mixing them with request-only options is ambiguous and could change the return type.
+  if (
+    options !== undefined ||
+    keys.some((key) => !normalizeRequestOptionsForQueryKeys.has(key) || queryKeys.includes(key))
+  ) {
+    throw new TypeError('Query parameters and request options must be passed as separate arguments.');
+  }
+  // The query position must not gain authority to change the request destination
+  // or transport. Those overrides require the explicit request options argument.
+  if (
+    keys.some(
+      (key) => !['headers', 'maxRetries', 'timeout', 'signal', 'idempotencyKey', 'query'].includes(key),
+    )
+  ) {
+    throw new TypeError('Pass transport overrides in the explicit request options argument.');
+  }
+  // Copy only the validated fields. Spreading value would reintroduce undefined
+  // transport overrides, and deleting them would mutate the caller's object.
+  return Object.fromEntries(
+    entries.map(([key, descriptor]) => {
+      if ('value' in descriptor) return [key, descriptor.value];
+      return [key, descriptor.get ? Reflect.apply(descriptor.get, value, []) : undefined];
+    }),
+  ) as {
+    [K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query']?: RequestOptions[K];
+  } & {
+    [
+      K in
+        | 'method'
+        | 'path'
+        | 'body'
+        | 'stream'
+        | 'httpAgent'
+        | 'fetchOptions'
+        | 'defaultBaseURL'
+        | '__metadata'
+        | '__binaryRequest'
+        | '__binaryResponse'
+        | '__streamClass'
+        | '__security'
+        | '__synthesizeEventData'
+    ]?: never;
+  };
+}
+
 export class Agents extends APIResource {
   environments: EnvironmentsAPI.Environments = new EnvironmentsAPI.Environments(this._client);
   vaults: VaultsAPI.Vaults = new VaultsAPI.Vaults(this._client);
@@ -108,9 +215,101 @@ export class Agents extends APIResource {
    * ```
    */
   list(
-    query: AgentListParams | null | undefined = {},
+    query?:
+      | (AgentListParams &
+          (
+            | {
+                [
+                  K in
+                    | 'method'
+                    | 'path'
+                    | 'query'
+                    | 'body'
+                    | 'headers'
+                    | 'maxRetries'
+                    | 'stream'
+                    | 'timeout'
+                    | 'httpAgent'
+                    | 'fetchOptions'
+                    | 'signal'
+                    | 'idempotencyKey'
+                    | 'defaultBaseURL'
+                    | '__metadata'
+                    | '__binaryRequest'
+                    | '__binaryResponse'
+                    | '__streamClass'
+                    | '__security'
+                    | '__synthesizeEventData'
+                ]?: never;
+              }
+            | null
+            | undefined
+          ))
+      | null
+      | undefined,
+    options?: RequestOptions,
+  ): PagePromise<AgentsPage, Agent>;
+  list(
+    options?: {
+      [K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query']?: RequestOptions[K];
+    } & {
+      [
+        K in
+          | 'method'
+          | 'path'
+          | 'body'
+          | 'stream'
+          | 'httpAgent'
+          | 'fetchOptions'
+          | 'defaultBaseURL'
+          | '__metadata'
+          | '__binaryRequest'
+          | '__binaryResponse'
+          | '__streamClass'
+          | '__security'
+          | '__synthesizeEventData'
+      ]?: never;
+    },
+  ): PagePromise<AgentsPage, Agent>;
+  list(
+    query:
+      | AgentListParams
+      | ({
+          [
+            K in 'headers' | 'maxRetries' | 'timeout' | 'signal' | 'idempotencyKey' | 'query'
+          ]?: RequestOptions[K];
+        } & {
+          [
+            K in
+              | 'method'
+              | 'path'
+              | 'body'
+              | 'stream'
+              | 'httpAgent'
+              | 'fetchOptions'
+              | 'defaultBaseURL'
+              | '__metadata'
+              | '__binaryRequest'
+              | '__binaryResponse'
+              | '__streamClass'
+              | '__security'
+              | '__synthesizeEventData'
+          ]?: never;
+        })
+      | null
+      | undefined = {},
     options?: RequestOptions,
   ): PagePromise<AgentsPage, Agent> {
+    const normalizeRequestOptionsForQueryOptions = normalizeRequestOptionsForQuery(
+      query,
+      ['after', 'limit', 'order'],
+      options,
+    );
+    if (normalizeRequestOptionsForQueryOptions !== undefined) {
+      options = normalizeRequestOptionsForQueryOptions;
+      query = {};
+    }
+    query = query as AgentListParams | null | undefined;
     return this._client.getAPIList('/agents', CursorPage<Agent>, {
       query,
       ...options,
@@ -607,12 +806,13 @@ export type AgentOutputItemStatus = 'in_progress' | 'completed' | 'incomplete';
  */
 export interface AgentReasoning {
   /**
-   * The amount of reasoning effort used by an agent.
+   * The requested reasoning effort, or `null` when the model selects its own
+   * default.
    */
   effort: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
 
   /**
-   * The reasoning summary format requested from an agent.
+   * The requested reasoning summary format, or `null` when summaries are disabled.
    *
    * - `concise` - Returns a concise reasoning summary when supported.
    * - `detailed` - Returns a detailed reasoning summary when supported.
@@ -632,7 +832,7 @@ export interface AgentReasoningItem {
   id: string;
 
   /**
-   * The status of an agent output item.
+   * The status of the reasoning item.
    */
   status: AgentOutputItemStatus | null;
 
@@ -657,12 +857,13 @@ export interface AgentReasoningItem {
  */
 export interface AgentReasoningParam {
   /**
-   * The amount of reasoning effort the model should use.
+   * The amount of reasoning effort the model should use. Omission lets the model
+   * select it.
    */
   effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
 
   /**
-   * The reasoning summary format requested from the model.
+   * Controls whether the response includes a reasoning summary.
    *
    * - `concise` - Returns a concise reasoning summary when supported.
    * - `detailed` - Returns a detailed reasoning summary when supported.
@@ -811,7 +1012,8 @@ export interface AgentSession {
   status: 'idle' | 'in_progress' | 'requires_action' | 'failed';
 
   /**
-   * Recorded token usage for a session or turn. Usage is best effort and may change.
+   * Best-effort token usage for the session, or null if unknown. Recorded usage may
+   * change.
    */
   usage: TokenUsage | null;
 
@@ -934,7 +1136,7 @@ export interface AgentSessionAssistantMessage {
   content: Array<OutputText>;
 
   /**
-   * The phase of an assistant message.
+   * The phase of the assistant message.
    *
    * - `commentary` - Commentary produced while the agent works.
    * - `final_answer` - The agent's final answer.
@@ -1164,7 +1366,7 @@ export interface AgentSessionEnvironmentState {
   id: string;
 
   /**
-   * An error reported while preparing a session environment.
+   * The error reported while preparing the environment, if any.
    */
   error: AgentSessionEnvironmentState.Error | null;
 
@@ -1187,7 +1389,7 @@ export interface AgentSessionEnvironmentState {
 
 export namespace AgentSessionEnvironmentState {
   /**
-   * An error reported while preparing a session environment.
+   * The error reported while preparing the environment, if any.
    */
   export interface Error {
     /**
@@ -1411,7 +1613,7 @@ export namespace AgentSessionInputParam {
     error?: string | null;
 
     /**
-     * A function result represented as text or supported model-input content.
+     * The function result when the call succeeded.
      */
     output?: AgentsAPI.AgentFunctionCallOutputParam | null;
   }
@@ -1457,7 +1659,7 @@ export namespace AgentSessionItem {
     error: string | null;
 
     /**
-     * The text or model-input content supplied as a function result.
+     * The function result, if the call succeeded.
      */
     output: AgentsAPI.AgentFunctionCallOutput | null;
 
@@ -1529,7 +1731,7 @@ export interface AgentSessionMessage {
   content: Array<AgentSessionMessageContent>;
 
   /**
-   * The phase of an assistant message.
+   * The phase of an assistant message. Null for user messages.
    *
    * - `commentary` - Commentary produced while the agent works.
    * - `final_answer` - The agent's final answer.
@@ -1723,7 +1925,7 @@ export interface AgentSessionTurnCancelledEvent {
   type: 'agent.session.turn.cancelled';
 
   /**
-   * Recorded token usage for a session or turn. Usage is best effort and may change.
+   * Token usage by the root agent during the turn, when available.
    */
   usage: TokenUsage | null;
 }
@@ -1758,7 +1960,7 @@ export interface AgentSessionTurnCompletedEvent {
   type: 'agent.session.turn.completed';
 
   /**
-   * Recorded token usage for a session or turn. Usage is best effort and may change.
+   * Token usage by the root agent during the turn, when available.
    */
   usage: TokenUsage | null;
 }
@@ -1913,7 +2115,7 @@ export interface AgentSessionTurnFailedEvent {
   type: 'agent.session.turn.failed';
 
   /**
-   * Recorded token usage for a session or turn. Usage is best effort and may change.
+   * Token usage by the root agent during the turn, when available.
    */
   usage: TokenUsage | null;
 }
@@ -2315,12 +2517,13 @@ export interface AgentText {
  */
 export interface AgentTextParam {
   /**
-   * The output format for generated text.
+   * The output format. Omission uses ordinary text (`{"type": "text"}`).
    */
   format?: TextFormatParam | null;
 
   /**
-   * The amount of text the model should produce.
+   * The amount of text the model should produce. Defaults to `medium`, matching
+   * Responses.
    *
    * - `low` - Produces less text.
    * - `medium` - Uses the default amount of text.
@@ -2445,7 +2648,7 @@ export namespace AgentTool {
     context_size: 'low' | 'medium' | 'high';
 
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results, if provided.
      */
     location: AgentToolResourceWebSearch.Location | null;
 
@@ -2462,7 +2665,7 @@ export namespace AgentTool {
 
   export namespace AgentToolResourceWebSearch {
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results, if provided.
      */
     export interface Location {
       /**
@@ -2580,7 +2783,9 @@ export namespace AgentToolParam {
     allowed_tools?: Array<string> | null;
 
     /**
-     * Where outbound MCP HTTP connections originate.
+     * Selects where outbound MCP HTTP connections originate. Omitted or `service` uses
+     * the Managed Agents service network; `environment` uses the session's selected
+     * environment.
      *
      * - `service` - Uses the Managed Agents service network.
      * - `environment` - Uses the session's execution environment.
@@ -2620,17 +2825,17 @@ export namespace AgentToolParam {
     allowed_domains?: Array<string> | null;
 
     /**
-     * The amount of web search context made available to the model.
+     * The amount of search context made available to the model. Defaults to `medium`.
      */
     context_size?: 'low' | 'medium' | 'high' | null;
 
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results.
      */
     location?: AgentToolConfigParamWebSearch.Location | null;
 
     /**
-     * The source used for web search results.
+     * The source used for web search results. Defaults to `live`.
      *
      * - `disabled` - Disables web search.
      * - `cached` - Uses cached search results.
@@ -2641,7 +2846,7 @@ export namespace AgentToolParam {
 
   export namespace AgentToolConfigParamWebSearch {
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results.
      */
     export interface Location {
       /**
@@ -2712,7 +2917,7 @@ export interface AgentWebSearchCallItem {
   id: string;
 
   /**
-   * An action performed by the web search tool.
+   * The action performed by the web search tool.
    */
   action: WebSearchAction | null;
 
@@ -2921,12 +3126,13 @@ export namespace EnvironmentParam {
     files?: Array<AgentsAPI.HostedEnvironmentFileParam> | null;
 
     /**
-     * Network access for an OpenAI-hosted environment.
+     * Network access policy for the environment. Defaults to disabled for GA requests
+     * and enabled for alpha/beta requests.
      */
     network?: EnvironmentParamOpenAIHosted.Network | null;
 
     /**
-     * Packages to install in an OpenAI-hosted environment.
+     * Packages to install in the environment. Defaults to empty package lists.
      */
     packages?: EnvironmentParamOpenAIHosted.Packages | null;
 
@@ -2949,7 +3155,8 @@ export namespace EnvironmentParam {
 
   export namespace EnvironmentParamOpenAIHosted {
     /**
-     * Network access for an OpenAI-hosted environment.
+     * Network access policy for the environment. Defaults to disabled for GA requests
+     * and enabled for alpha/beta requests.
      */
     export interface Network {
       /**
@@ -2968,7 +3175,7 @@ export namespace EnvironmentParam {
     }
 
     /**
-     * Packages to install in an OpenAI-hosted environment.
+     * Packages to install in the environment. Defaults to empty package lists.
      */
     export interface Packages {
       /**
@@ -3671,7 +3878,7 @@ export namespace PersistedAgentTool {
     context_size: 'low' | 'medium' | 'high';
 
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results, if provided.
      */
     location: PersistedAgentToolResourceWebSearch.Location | null;
 
@@ -3688,7 +3895,7 @@ export namespace PersistedAgentTool {
 
   export namespace PersistedAgentToolResourceWebSearch {
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results, if provided.
      */
     export interface Location {
       /**
@@ -3806,7 +4013,7 @@ export namespace PersistedAgentToolParam {
     allowed_tools?: Array<string> | null;
 
     /**
-     * Where outbound MCP HTTP connections originate.
+     * Selects where outbound MCP HTTP connections originate.
      *
      * - `service` - Uses the Managed Agents service network.
      * - `environment` - Uses the session's execution environment.
@@ -3846,17 +4053,17 @@ export namespace PersistedAgentToolParam {
     allowed_domains?: Array<string> | null;
 
     /**
-     * The amount of web search context made available to the model.
+     * The amount of search context made available to the model. Defaults to `medium`.
      */
     context_size?: 'low' | 'medium' | 'high' | null;
 
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results.
      */
     location?: PersistedAgentToolConfigParamWebSearch.Location | null;
 
     /**
-     * The source used for web search results.
+     * The source used for web search results. Defaults to `live`.
      *
      * - `disabled` - Disables web search.
      * - `cached` - Uses cached search results.
@@ -3867,7 +4074,7 @@ export namespace PersistedAgentToolParam {
 
   export namespace PersistedAgentToolConfigParamWebSearch {
     /**
-     * Approximate user location used to localize web search results.
+     * Approximate location used to localize search results.
      */
     export interface Location {
       /**
@@ -4388,7 +4595,8 @@ export interface AgentCreateParams {
   metadata?: { [key: string]: string } | null;
 
   /**
-   * Explicit configuration for creating and coordinating subagents.
+   * Configuration for creating and coordinating subagents. Subagent tools are
+   * disabled by default.
    */
   multi_agent?: MultiAgentConfigParam | null;
 
@@ -4398,12 +4606,12 @@ export interface AgentCreateParams {
   name?: string | null;
 
   /**
-   * Reasoning configuration for the agent.
+   * Configuration for model reasoning. Omission uses the model's default effort.
    */
   reasoning?: AgentReasoningParam | null;
 
   /**
-   * The service tier used for model requests.
+   * The service tier used for model requests. Defaults to `auto`.
    *
    * - `auto` - Selects the service tier automatically.
    * - `default` - Uses the default service tier.
@@ -4414,7 +4622,8 @@ export interface AgentCreateParams {
   service_tier?: 'auto' | 'default' | 'flex' | 'priority' | 'fast' | null;
 
   /**
-   * Configuration for text generated by the agent.
+   * Configuration for generated text. Defaults to the `text` format and medium
+   * verbosity.
    */
   text?: AgentTextParam | null;
 
@@ -4444,7 +4653,7 @@ export interface AgentUpdateParams {
   model?: string;
 
   /**
-   * Explicit configuration for creating and coordinating subagents.
+   * Configuration for creating and coordinating subagents.
    */
   multi_agent?: MultiAgentConfigParam | null;
 
@@ -4454,7 +4663,8 @@ export interface AgentUpdateParams {
   name?: string | null;
 
   /**
-   * Reasoning configuration for the agent.
+   * Configuration for model reasoning. Omit to keep the current settings; pass
+   * `null` to reset to the model's default effort.
    */
   reasoning?: AgentReasoningParam | null;