openai 6.46.0 → 6.48.0

package/src/lib/RunnableFunction.ts

@@ -4,15 +4,17 @@ import { JSONSchema } from './jsonschema';
 
 type PromiseOrValue<T> = T | Promise<T>;
 
-export type RunnableFunctionWithParse<Args extends object> = {
+export type RunnableFunctionWithParse<Args extends object, ToolContext = unknown> = {
   /**
    * @param args the return value from `parse`.
    * @param runner the runner evaluating this callback.
+   * @param toolContext the context passed to `.runTools()`.
    * @returns a string to send back to OpenAI.
    */
   function: (
     args: Args,
     runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>,
+    toolContext: ToolContext,
   ) => PromiseOrValue<unknown>;
   /**
    * @param input the raw args from the OpenAI function call.
@@ -34,14 +36,17 @@ export type RunnableFunctionWithParse<Args extends object> = {
   strict?: boolean | undefined;
 };
 
-export type RunnableFunctionWithoutParse = {
+export type RunnableFunctionWithoutParse<ToolContext = unknown> = {
   /**
    * @param args the raw args from the OpenAI function call.
+   * @param runner the runner evaluating this callback.
+   * @param toolContext the context passed to `.runTools()`.
    * @returns a string to send back to OpenAI
    */
   function: (
     args: string,
     runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>,
+    toolContext: ToolContext,
   ) => PromiseOrValue<unknown>;
   /**
    * The parameters the function accepts, describes as a JSON Schema object.
@@ -58,56 +63,80 @@ export type RunnableFunctionWithoutParse = {
   strict?: boolean | undefined;
 };
 
-export type RunnableFunction<Args extends object | string> =
-  Args extends string ? RunnableFunctionWithoutParse
-  : Args extends object ? RunnableFunctionWithParse<Args>
-  : never;
+export type RunnableFunction<Args extends object | string, ToolContext = unknown> = Args extends string ?
+  RunnableFunctionWithoutParse<ToolContext>
+: Args extends object ? RunnableFunctionWithParse<Args, ToolContext>
+: never;
 
-export type RunnableToolFunction<Args extends object | string> =
-  Args extends string ? RunnableToolFunctionWithoutParse
-  : Args extends object ? RunnableToolFunctionWithParse<Args>
-  : never;
+export type RunnableToolFunction<Args extends object | string, ToolContext = unknown> = Args extends string ?
+  RunnableToolFunctionWithoutParse<ToolContext>
+: Args extends object ? RunnableToolFunctionWithParse<Args, ToolContext>
+: never;
 
-export type RunnableToolFunctionWithoutParse = {
+export type RunnableToolFunctionWithoutParse<ToolContext = unknown> = {
+  type: 'function';
+  function: RunnableFunctionWithoutParse<ToolContext>;
+};
+export type RunnableToolFunctionWithParse<Args extends object, ToolContext = unknown> = {
   type: 'function';
-  function: RunnableFunctionWithoutParse;
+  function: RunnableFunctionWithParse<Args, ToolContext>;
 };
-export type RunnableToolFunctionWithParse<Args extends object> = {
+
+/**
+ * A broad tool shape for contextually typing callbacks when the argument type is inferred.
+ */
+export type RunnableToolFunctionWithContext<ToolContext> = {
   type: 'function';
-  function: RunnableFunctionWithParse<Args>;
+  function: {
+    function: (
+      args: any,
+      runner: ChatCompletionRunner<unknown> | ChatCompletionStreamingRunner<unknown>,
+      toolContext: ToolContext,
+    ) => PromiseOrValue<unknown>;
+    parse?: (input: string) => PromiseOrValue<any>;
+    parameters: JSONSchema;
+    description: string;
+    name?: string | undefined;
+    strict?: boolean | undefined;
+  };
 };
 
-export function isRunnableFunctionWithParse<Args extends object>(
+export function isRunnableFunctionWithParse<Args extends object, ToolContext = unknown>(
   fn: any,
-): fn is RunnableFunctionWithParse<Args> {
+): fn is RunnableFunctionWithParse<Args, ToolContext> {
   return typeof (fn as any).parse === 'function';
 }
 
 export type BaseFunctionsArgs = readonly (object | string)[];
 
-export type RunnableFunctions<FunctionsArgs extends BaseFunctionsArgs> =
-  [any[]] extends [FunctionsArgs] ? readonly RunnableFunction<any>[]
-  : {
-      [Index in keyof FunctionsArgs]: Index extends number ? RunnableFunction<FunctionsArgs[Index]>
-      : FunctionsArgs[Index];
-    };
+export type RunnableFunctions<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [
+  any[],
+] extends [FunctionsArgs] ?
+  readonly RunnableFunction<any, ToolContext>[]
+: {
+    [Index in keyof FunctionsArgs]: Index extends number ? RunnableFunction<FunctionsArgs[Index], ToolContext>
+    : FunctionsArgs[Index];
+  };
 
-export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs> =
-  [any[]] extends [FunctionsArgs] ? readonly RunnableToolFunction<any>[]
-  : {
-      [Index in keyof FunctionsArgs]: Index extends number ? RunnableToolFunction<FunctionsArgs[Index]>
-      : FunctionsArgs[Index];
-    };
+export type RunnableTools<FunctionsArgs extends BaseFunctionsArgs, ToolContext = unknown> = [any[]] extends (
+  [FunctionsArgs]
+) ?
+  readonly RunnableToolFunction<any, ToolContext>[]
+: {
+    [Index in keyof FunctionsArgs]: Index extends number ?
+      RunnableToolFunction<FunctionsArgs[Index], ToolContext>
+    : FunctionsArgs[Index];
+  };
 
 /**
  * This is helper class for passing a `function` and `parse` where the `function`
  * argument type matches the `parse` return type.
  */
-export class ParsingToolFunction<Args extends object> {
+export class ParsingToolFunction<Args extends object, ToolContext = unknown> {
   type: 'function';
-  function: RunnableFunctionWithParse<Args>;
+  function: RunnableFunctionWithParse<Args, ToolContext>;
 
-  constructor(input: RunnableFunctionWithParse<Args>) {
+  constructor(input: RunnableFunctionWithParse<Args, ToolContext>) {
     this.type = 'function';
     this.function = input;
   }

package/src/lib/parser.ts

@@ -7,8 +7,10 @@ import {
   ChatCompletionMessage,
   ChatCompletionMessageFunctionToolCall,
   ChatCompletionStreamingToolRunnerParams,
+  ChatCompletionStreamingToolRunnerParamsWithContext,
   ChatCompletionStreamParams,
   ChatCompletionToolRunnerParams,
+  ChatCompletionToolRunnerParamsWithContext,
   ParsedChatCompletion,
   ParsedChoice,
   ParsedFunctionToolCall,
@@ -19,7 +21,9 @@ import { ResponseFormatJSONSchema } from '../resources/shared';
 type AnyChatCompletionCreateParams =
   | ChatCompletionCreateParams
   | ChatCompletionToolRunnerParams<any>
+  | ChatCompletionToolRunnerParamsWithContext<any, any>
   | ChatCompletionStreamingToolRunnerParams<any>
+  | ChatCompletionStreamingToolRunnerParamsWithContext<any, any>
   | ChatCompletionStreamParams;
 
 type Unpacked<T> = T extends (infer U)[] ? U : T;

package/src/lib/responses/ResponseStream.ts

@@ -7,6 +7,7 @@ import {
   type ResponseStreamEvent,
 } from '../../resources/responses/responses';
 import { RequestOptions } from '../../internal/request-options';
+import { type ReadableStream } from '../../internal/shim-types';
 import { APIUserAbortError, OpenAIError } from '../../error';
 import OpenAI from '../../index';
 import { type BaseEvents, EventStream } from '../EventStream';
@@ -27,7 +28,9 @@ export type ResponseStreamByIdParams = {
    */
   response_id: string;
   /**
-   * If provided, the stream will start after the event with the given sequence number.
+   * If provided, events with a sequence number less than or equal to this value
+   * will not be emitted. The helper still replays them internally to build a
+   * complete snapshot for later events and `finalResponse()`.
    */
   starting_after?: number;
   /**
@@ -90,6 +93,12 @@ export class ResponseStream<ParsedT = null>
     return runner;
   }
 
+  static fromReadableStream(stream: ReadableStream): ResponseStream<null> {
+    const runner = new ResponseStream(null);
+    runner._run(() => runner._fromReadableStream(stream));
+    return runner;
+  }
+
   #beginRequest() {
     if (this.ended) return;
     this.#currentResponseSnapshot = undefined;
@@ -175,6 +184,8 @@ export class ResponseStream<ParsedT = null>
     let stream: Stream<ResponseStreamEvent> | undefined;
     let starting_after: number | null = null;
     if ('response_id' in params) {
+      // Keep the full replay so that `accumulateResponse()` sees `response.created` and can build
+      // complete snapshots before locally filtering events at `starting_after`.
       stream = await client.responses.retrieve(
         params.response_id,
         { stream: true },
@@ -198,6 +209,23 @@ export class ResponseStream<ParsedT = null>
     return this.#endRequest();
   }
 
+  protected async _fromReadableStream(
+    readableStream: ReadableStream,
+    options?: RequestOptions,
+  ): Promise<ParsedResponse<ParsedT>> {
+    this._listenForAbort(options?.signal);
+    this.#beginRequest();
+    this._connected();
+    const stream = Stream.fromReadableStream<ResponseStreamEvent>(readableStream, this.controller);
+    for await (const event of stream) {
+      this.#addEvent(event, null);
+    }
+    if (stream.controller.signal?.aborted) {
+      throw new APIUserAbortError();
+    }
+    return this.#endRequest();
+  }
+
   [Symbol.asyncIterator](this: ResponseStream<ParsedT>): AsyncIterator<ResponseStreamEvent> {
     const pushQueue: ResponseStreamEvent[] = [];
     const readQueue: {

package/src/resources/admin/organization/audit-logs.ts

@@ -113,7 +113,91 @@ export interface AuditLogListResponse {
     | 'service_account.deleted'
     | 'user.added'
     | 'user.updated'
-    | 'user.deleted';
+    | 'user.deleted'
+    | 'tenant.metadata.updated'
+    | 'tenant.microsoft_entra_mapping.upserted'
+    | 'tenant.microsoft_entra_mapping.deleted'
+    | 'tenant.workload_identity.provider.created'
+    | 'tenant.workload_identity.provider.updated'
+    | 'tenant.workload_identity.provider.archived'
+    | 'tenant.workload_identity.mapping.created'
+    | 'tenant.workload_identity.mapping.updated'
+    | 'tenant.workload_identity.mapping.archived'
+    | 'tenant.workload_identity.binding.created'
+    | 'tenant.workload_identity.principal.provisioned'
+    | 'tenant.admin_api_key.created'
+    | 'tenant.admin_api_key.updated'
+    | 'tenant.admin_api_key.deleted'
+    | 'tenant.project_api_key.created'
+    | 'tenant.chatgpt_access_token.revoked'
+    | 'tenant.migration.completed'
+    | 'tenant.sso.migrated'
+    | 'tenant.domains.migrated'
+    | 'tenant.sso_connection.created'
+    | 'tenant.sso_connection.updated'
+    | 'tenant.sso_connection.deleted'
+    | 'tenant.sso_connection.setup.started'
+    | 'tenant.policy.created'
+    | 'tenant.policy.updated'
+    | 'tenant.policy.deleted'
+    | 'tenant.policy.attached'
+    | 'tenant.policy.detached'
+    | 'tenant.principal_authentication_policy.resolved'
+    | 'tenant.scim.setup.started'
+    | 'tenant.scim.deletion.requested'
+    | 'tenant.scim.directory.created'
+    | 'tenant.product_access_policy.updated'
+    | 'tenant.resource_share_grant.created'
+    | 'tenant.resource_share_grant.updated'
+    | 'tenant.resource_share_grant.accepted'
+    | 'tenant.resource_share_grant.declined'
+    | 'tenant.resource_share_grant.revoked'
+    | 'tenant.resource_share_grant.deleted'
+    | 'tenant.service_account.updated'
+    | 'tenant.service_account.deleted'
+    | 'tenant.service_account.token.revoked'
+    | 'tenant.billing.overage_limit.updated'
+    | 'tenant.billing.alerts.updated'
+    | 'tenant.billing.info.updated'
+    | 'tenant.usage_limit.workspace.updated'
+    | 'tenant.usage_limit.group.updated'
+    | 'tenant.usage_limit.user.updated'
+    | 'tenant.usage_limit.increase_request.updated'
+    | 'tenant.usage_limit.increase_request.resolved'
+    | 'tenant.group.created'
+    | 'tenant.group.updated'
+    | 'tenant.group.deleted'
+    | 'tenant.group.member.added'
+    | 'tenant.group.member.removed'
+    | 'tenant.migration_rollout.status.updated'
+    | 'tenant.migration_rollout.tier.updated'
+    | 'tenant.role.metadata.updated'
+    | 'tenant.custom_role.created'
+    | 'tenant.custom_role.updated'
+    | 'tenant.custom_role.deleted'
+    | 'tenant.role_assignment.created'
+    | 'tenant.role_assignment.deleted'
+    | 'tenant.resource_role_assignment.created'
+    | 'tenant.resource_role_assignment.deleted'
+    | 'tenant.resource_access.updated'
+    | 'tenant.resource_access.deleted'
+    | 'tenant.session_policy.created'
+    | 'tenant.session_policy.updated'
+    | 'tenant.session_policy.deleted'
+    | 'tenant.session_revocation.started'
+    | 'tenant.third_party_app_policy.updated'
+    | 'tenant.user.added'
+    | 'tenant.user.updated'
+    | 'tenant.user.removed'
+    | 'tenant.user.looked_up'
+    | 'tenant.user.invited'
+    | 'tenant.membership.revoked'
+    | 'tenant.api_organization_invite.upserted'
+    | 'tenant.api_organization_invite.deleted'
+    | 'tenant.chatgpt_workspace_invite.upserted'
+    | 'tenant.membership.accepted'
+    | 'tenant.membership.declined'
+    | 'tenant.workspace_invite_email_settings.updated';
 
   /**
    * The actor who performed the audit logged action.
@@ -1834,6 +1918,90 @@ export interface AuditLogListParams extends ConversationCursorPageParams {
     | 'user.added'
     | 'user.updated'
     | 'user.deleted'
+    | 'tenant.metadata.updated'
+    | 'tenant.microsoft_entra_mapping.upserted'
+    | 'tenant.microsoft_entra_mapping.deleted'
+    | 'tenant.workload_identity.provider.created'
+    | 'tenant.workload_identity.provider.updated'
+    | 'tenant.workload_identity.provider.archived'
+    | 'tenant.workload_identity.mapping.created'
+    | 'tenant.workload_identity.mapping.updated'
+    | 'tenant.workload_identity.mapping.archived'
+    | 'tenant.workload_identity.binding.created'
+    | 'tenant.workload_identity.principal.provisioned'
+    | 'tenant.admin_api_key.created'
+    | 'tenant.admin_api_key.updated'
+    | 'tenant.admin_api_key.deleted'
+    | 'tenant.project_api_key.created'
+    | 'tenant.chatgpt_access_token.revoked'
+    | 'tenant.migration.completed'
+    | 'tenant.sso.migrated'
+    | 'tenant.domains.migrated'
+    | 'tenant.sso_connection.created'
+    | 'tenant.sso_connection.updated'
+    | 'tenant.sso_connection.deleted'
+    | 'tenant.sso_connection.setup.started'
+    | 'tenant.policy.created'
+    | 'tenant.policy.updated'
+    | 'tenant.policy.deleted'
+    | 'tenant.policy.attached'
+    | 'tenant.policy.detached'
+    | 'tenant.principal_authentication_policy.resolved'
+    | 'tenant.scim.setup.started'
+    | 'tenant.scim.deletion.requested'
+    | 'tenant.scim.directory.created'
+    | 'tenant.product_access_policy.updated'
+    | 'tenant.resource_share_grant.created'
+    | 'tenant.resource_share_grant.updated'
+    | 'tenant.resource_share_grant.accepted'
+    | 'tenant.resource_share_grant.declined'
+    | 'tenant.resource_share_grant.revoked'
+    | 'tenant.resource_share_grant.deleted'
+    | 'tenant.service_account.updated'
+    | 'tenant.service_account.deleted'
+    | 'tenant.service_account.token.revoked'
+    | 'tenant.billing.overage_limit.updated'
+    | 'tenant.billing.alerts.updated'
+    | 'tenant.billing.info.updated'
+    | 'tenant.usage_limit.workspace.updated'
+    | 'tenant.usage_limit.group.updated'
+    | 'tenant.usage_limit.user.updated'
+    | 'tenant.usage_limit.increase_request.updated'
+    | 'tenant.usage_limit.increase_request.resolved'
+    | 'tenant.group.created'
+    | 'tenant.group.updated'
+    | 'tenant.group.deleted'
+    | 'tenant.group.member.added'
+    | 'tenant.group.member.removed'
+    | 'tenant.migration_rollout.status.updated'
+    | 'tenant.migration_rollout.tier.updated'
+    | 'tenant.role.metadata.updated'
+    | 'tenant.custom_role.created'
+    | 'tenant.custom_role.updated'
+    | 'tenant.custom_role.deleted'
+    | 'tenant.role_assignment.created'
+    | 'tenant.role_assignment.deleted'
+    | 'tenant.resource_role_assignment.created'
+    | 'tenant.resource_role_assignment.deleted'
+    | 'tenant.resource_access.updated'
+    | 'tenant.resource_access.deleted'
+    | 'tenant.session_policy.created'
+    | 'tenant.session_policy.updated'
+    | 'tenant.session_policy.deleted'
+    | 'tenant.session_revocation.started'
+    | 'tenant.third_party_app_policy.updated'
+    | 'tenant.user.added'
+    | 'tenant.user.updated'
+    | 'tenant.user.removed'
+    | 'tenant.user.looked_up'
+    | 'tenant.user.invited'
+    | 'tenant.membership.revoked'
+    | 'tenant.api_organization_invite.upserted'
+    | 'tenant.api_organization_invite.deleted'
+    | 'tenant.chatgpt_workspace_invite.upserted'
+    | 'tenant.membership.accepted'
+    | 'tenant.membership.declined'
+    | 'tenant.workspace_invite_email_settings.updated'
   >;
 
   /**

package/src/resources/admin/organization/projects/api-keys.ts

@@ -121,6 +121,11 @@ export interface ProjectAPIKey {
 
   owner: ProjectAPIKey.Owner;
 
+  /**
+   * Whether the API key's owner currently has effective access to the project.
+   */
+  owner_project_access: 'active' | 'inactive';
+
   /**
    * The redacted value of the API key
    */
@@ -218,7 +223,16 @@ export interface APIKeyRetrieveParams {
   project_id: string;
 }
 
-export interface APIKeyListParams extends ConversationCursorPageParams {}
+export interface APIKeyListParams extends ConversationCursorPageParams {
+  /**
+   * Filter API keys by whether the owner currently has effective access to the
+   * project. Use `active` for owners with access, `inactive` for owners without
+   * access, or `any` for all enabled project API keys. If omitted, the endpoint
+   * applies its existing membership-based visibility rules, which may exclude some
+   * enabled keys.
+   */
+  owner_project_access?: 'active' | 'inactive' | 'any';
+}
 
 export interface APIKeyDeleteParams {
   /**

package/src/resources/admin/organization/projects/index.ts

@@ -78,7 +78,7 @@ export {
   type ServiceAccountListParams,
   type ServiceAccountDeleteParams,
   type ProjectServiceAccountsPage,
-} from './service-accounts';
+} from './service-accounts/index';
 export {
   SpendAlerts,
   type ProjectSpendAlert,

package/src/resources/admin/organization/projects/projects.ts

@@ -57,19 +57,6 @@ import {
   RoleUpdateParams,
   Roles,
 } from './roles';
-import * as ServiceAccountsAPI from './service-accounts';
-import {
-  ProjectServiceAccount,
-  ProjectServiceAccountsPage,
-  ServiceAccountCreateParams,
-  ServiceAccountCreateResponse,
-  ServiceAccountDeleteParams,
-  ServiceAccountDeleteResponse,
-  ServiceAccountListParams,
-  ServiceAccountRetrieveParams,
-  ServiceAccountUpdateParams,
-  ServiceAccounts,
-} from './service-accounts';
 import * as SpendAlertsAPI from './spend-alerts';
 import {
   ProjectSpendAlert,
@@ -93,6 +80,19 @@ import {
   ProjectGroup,
   ProjectGroupsPage,
 } from './groups/groups';
+import * as ServiceAccountsAPI from './service-accounts/service-accounts';
+import {
+  ProjectServiceAccount,
+  ProjectServiceAccountsPage,
+  ServiceAccountCreateParams,
+  ServiceAccountCreateResponse,
+  ServiceAccountDeleteParams,
+  ServiceAccountDeleteResponse,
+  ServiceAccountListParams,
+  ServiceAccountRetrieveParams,
+  ServiceAccountUpdateParams,
+  ServiceAccounts,
+} from './service-accounts/service-accounts';
 import * as UsersAPI from './users/users';
 import {
   ProjectUser,

package/src/resources/admin/organization/projects/service-accounts/api-keys.ts

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import { APIPromise } from '../../../../../core/api-promise';
+import { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
+
+export class APIKeys extends APIResource {
+  /**
+   * Creates an API key for a service account in the project.
+   *
+   * @example
+   * ```ts
+   * const apiKey =
+   *   await client.admin.organization.projects.serviceAccounts.apiKeys.create(
+   *     'service_account_id',
+   *     { project_id: 'project_id' },
+   *   );
+   * ```
+   */
+  create(
+    serviceAccountID: string,
+    params: APIKeyCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<APIKeyCreateResponse> {
+    const { project_id, ...body } = params;
+    return this._client.post(
+      path`/organization/projects/${project_id}/service_accounts/${serviceAccountID}/api_keys`,
+      { body, ...options, __security: { adminAPIKeyAuth: true } },
+    );
+  }
+}
+
+export interface APIKeyCreateResponse {
+  /**
+   * The identifier of the API key.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) when the API key was created.
+   */
+  created_at: number;
+
+  /**
+   * The name of the API key.
+   */
+  name: string;
+
+  /**
+   * The object type, which is always `organization.project.service_account.api_key`
+   */
+  object: 'organization.project.service_account.api_key';
+
+  /**
+   * The unredacted API key value.
+   */
+  value: string;
+}
+
+export interface APIKeyCreateParams {
+  /**
+   * Path param: The ID of the project.
+   */
+  project_id: string;
+
+  /**
+   * Body param: API key name.
+   */
+  name?: string;
+
+  /**
+   * Body param: API key scopes.
+   */
+  scopes?: Array<string>;
+}
+
+export declare namespace APIKeys {
+  export { type APIKeyCreateResponse as APIKeyCreateResponse, type APIKeyCreateParams as APIKeyCreateParams };
+}

package/src/resources/admin/organization/projects/service-accounts/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { APIKeys, type APIKeyCreateResponse, type APIKeyCreateParams } from './api-keys';
+export {
+  ServiceAccounts,
+  type ProjectServiceAccount,
+  type ServiceAccountCreateResponse,
+  type ServiceAccountDeleteResponse,
+  type ServiceAccountCreateParams,
+  type ServiceAccountRetrieveParams,
+  type ServiceAccountUpdateParams,
+  type ServiceAccountListParams,
+  type ServiceAccountDeleteParams,
+  type ProjectServiceAccountsPage,
+} from './service-accounts';