fixes

Author: RobertCraigie

.eslintrc.js

@@ -19,7 +19,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['tests/**', 'examples/**'],
+      files: ['tests/**', 'examples/**', 'ecosystem-tests/**'],
       rules: {
         'no-restricted-imports': 'off',
       },

src/api-promise.ts

@@ -62,7 +62,7 @@ export class APIPromise<T> extends Promise<WithRequestID<T>> {
    * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
    * to your `tsconfig.json`.
    */
-  async withResponse(): Promise<{ data: T; response: Response }> {
+  async withResponse(): Promise<{ data: T; response: Response; request_id: string | null }> {
     const [data, response] = await Promise.all([this.parse(), this.asResponse()]);
     return { data, response, request_id: response.headers.get('x-request-id') };
   }

src/azure.ts

@@ -124,11 +124,10 @@ export class AzureOpenAI extends OpenAI {
     this._deployment = deployment;
   }
 
-  override buildRequest(options: FinalRequestOptions<unknown>): {
-    req: RequestInit;
-    url: string;
-    timeout: number;
-  } {
+  override buildRequest(
+    options: FinalRequestOptions,
+    props: { retryCount?: number } = {},
+  ): { req: RequestInit & { headers: Headers }; url: string; timeout: number } {
     if (_deployments_endpoints.has(options.path) && options.method === 'post' && options.body !== undefined) {
       if (!isObj(options.body)) {
         throw new Error('Expected request body to be an object');
@@ -138,7 +137,7 @@ export class AzureOpenAI extends OpenAI {
         options.path = `/deployments/${model}${options.path}`;
       }
     }
-    return super.buildRequest(options);
+    return super.buildRequest(options, props);
   }
 
   private async _getAzureADToken(): Promise<string | undefined> {
@@ -159,21 +158,23 @@ export class AzureOpenAI extends OpenAI {
   }
 
   protected override async prepareOptions(opts: FinalRequestOptions): Promise<void> {
+    opts.headers = buildHeaders([opts.headers]);
+
     /**
      * The user should provide a bearer token provider if they want
      * to use Azure AD authentication. The user shouldn't set the
      * Authorization header manually because the header is overwritten
      * with the Azure AD token if a bearer token provider is provided.
      */
-    if (opts.headers?.['api-key']) {
+    if (opts.headers.values.get('Authorization') || opts.headers.values.get('api-key')) {
       return super.prepareOptions(opts);
     }
+
     const token = await this._getAzureADToken();
-    opts.headers ??= {};
     if (token) {
-      opts.headers['Authorization'] = `Bearer ${token}`;
+      opts.headers.values.set('Authorization', `Bearer ${token}`);
     } else if (this.apiKey !== API_KEY_SENTINEL) {
-      opts.headers['api-key'] = this.apiKey;
+      opts.headers.values.set('api-key', this.apiKey);
     } else {
       throw new Errors.OpenAIError('Unable to handle auth');
     }
@@ -189,6 +190,7 @@ const _deployments_endpoints = new Set([
   '/audio/translations',
   '/audio/speech',
   '/images/generations',
+  '/batches',
 ]);
 
 const API_KEY_SENTINEL = '<Missing Key>';

src/lib/AbstractChatCompletionRunner.ts

@@ -1,4 +1,3 @@
-import * as Core from '../core';
 import { type CompletionUsage } from '../resources/completions';
 import {
   type ChatCompletion,
@@ -24,9 +23,10 @@ import { BaseEvents, EventStream } from './EventStream';
 import { ParsedChatCompletion } from '../resources/beta/chat/completions';
 import OpenAI from '../index';
 import { isAutoParsableTool, parseChatCompletion } from '../lib/parser';
+import { RequestOptions } from '../internal/request-options';
 
 const DEFAULT_MAX_CHAT_COMPLETIONS = 10;
-export interface RunnerOptions extends Core.RequestOptions {
+export interface RunnerOptions extends RequestOptions {
   /** How many requests to make before canceling. Default 10. */
   maxChatCompletions?: number;
 }
@@ -238,7 +238,7 @@ export class AbstractChatCompletionRunner<
   protected async _createChatCompletion(
     client: OpenAI,
     params: ChatCompletionCreateParams,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ParsedChatCompletion<ParsedT>> {
     const signal = options?.signal;
     if (signal) {
@@ -258,7 +258,7 @@ export class AbstractChatCompletionRunner<
   protected async _runChatCompletion(
     client: OpenAI,
     params: ChatCompletionCreateParams,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ChatCompletion> {
     for (const message of params.messages) {
       this._addMessage(message, false);

src/lib/AssistantStream.ts

@@ -9,8 +9,7 @@ import {
   MessageDelta,
   MessageContent,
 } from '../resources/beta/threads/messages';
-import * as Core from '../core';
-import { RequestOptions } from '../core';
+import { RequestOptions } from '../internal/request-options';
 import {
   Run,
   RunCreateParamsBase,
@@ -19,7 +18,7 @@ import {
   RunSubmitToolOutputsParamsBase,
   RunSubmitToolOutputsParamsStreaming,
 } from '../resources/beta/threads/runs/runs';
-import { type ReadableStream } from '../_shims/index';
+import { type ReadableStream } from '../internal/shim-types';
 import { Stream } from '../streaming';
 import { APIUserAbortError, OpenAIError } from '../error';
 import {
@@ -31,6 +30,7 @@ import {
 import { RunStep, RunStepDelta, ToolCall, ToolCallDelta } from '../resources/beta/threads/runs/steps';
 import { ThreadCreateAndRunParamsBase, Threads } from '../resources/beta/threads/threads';
 import { BaseEvents, EventStream } from './EventStream';
+import { isObj } from '../internal/utils';
 
 export interface AssistantStreamEvents extends BaseEvents {
   run: (run: Run) => void;
@@ -163,7 +163,7 @@ export class AssistantStream
 
   protected async _fromReadableStream(
     readableStream: ReadableStream,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
     const signal = options?.signal;
     if (signal) {
@@ -187,15 +187,14 @@ export class AssistantStream
   }
 
   static createToolAssistantStream(
-    threadId: string,
     runId: string,
     runs: Runs,
     params: RunSubmitToolOutputsParamsStream,
     options: RequestOptions | undefined,
   ): AssistantStream {
     const runner = new AssistantStream();
     runner._run(() =>
-      runner._runToolAssistantStream(threadId, runId, runs, params, {
+      runner._runToolAssistantStream(runId, runs, params, {
         ...options,
         headers: { ...options?.headers, 'X-Stainless-Helper-Method': 'stream' },
       }),
@@ -205,10 +204,9 @@ export class AssistantStream
 
   protected async _createToolAssistantStream(
     run: Runs,
-    threadId: string,
     runId: string,
     params: RunSubmitToolOutputsParamsStream,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
     const signal = options?.signal;
     if (signal) {
@@ -217,7 +215,7 @@ export class AssistantStream
     }
 
     const body: RunSubmitToolOutputsParamsStreaming = { ...params, stream: true };
-    const stream = await run.submitToolOutputs(threadId, runId, body, {
+    const stream = await run.submitToolOutputs(runId, body, {
       ...options,
       signal: this.controller.signal,
     });
@@ -303,7 +301,7 @@ export class AssistantStream
   protected async _createThreadAssistantStream(
     thread: Threads,
     params: ThreadCreateAndRunParamsBase,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
     const signal = options?.signal;
     if (signal) {
@@ -330,7 +328,7 @@ export class AssistantStream
     run: Runs,
     threadId: string,
     params: RunCreateParamsBase,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
     const signal = options?.signal;
     if (signal) {
@@ -676,7 +674,7 @@ export class AssistantStream
         accValue += deltaValue;
       } else if (typeof accValue === 'number' && typeof deltaValue === 'number') {
         accValue += deltaValue;
-      } else if (Core.isObj(accValue) && Core.isObj(deltaValue)) {
+      } else if (isObj(accValue) && isObj(deltaValue)) {
         accValue = this.accumulateDelta(accValue as Record<string, any>, deltaValue as Record<string, any>);
       } else if (Array.isArray(accValue) && Array.isArray(deltaValue)) {
         if (accValue.every((x) => typeof x === 'string' || typeof x === 'number')) {
@@ -685,7 +683,7 @@ export class AssistantStream
         }
 
         for (const deltaEntry of deltaValue) {
-          if (!Core.isObj(deltaEntry)) {
+          if (!isObj(deltaEntry)) {
             throw new Error(`Expected array delta entry to be an object but got: ${deltaEntry}`);
           }
 
@@ -748,7 +746,7 @@ export class AssistantStream
   protected async _threadAssistantStream(
     params: ThreadCreateAndRunParamsBase,
     thread: Threads,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
     return await this._createThreadAssistantStream(thread, params, options);
   }
@@ -757,18 +755,17 @@ export class AssistantStream
     threadId: string,
     runs: Runs,
     params: RunCreateParamsBase,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
     return await this._createAssistantStream(runs, threadId, params, options);
   }
 
   protected async _runToolAssistantStream(
-    threadId: string,
     runId: string,
     runs: Runs,
     params: RunSubmitToolOutputsParamsStream,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<Run> {
-    return await this._createToolAssistantStream(runs, threadId, runId, params, options);
+    return await this._createToolAssistantStream(runs, runId, params, options);
   }
 }

src/lib/ChatCompletionStream.ts

@@ -1,4 +1,3 @@
-import * as Core from '../core';
 import {
   OpenAIError,
   APIUserAbortError,
@@ -17,7 +16,7 @@ import {
   AbstractChatCompletionRunner,
   type AbstractChatCompletionRunnerEvents,
 } from './AbstractChatCompletionRunner';
-import { type ReadableStream } from '../_shims/index';
+import { type ReadableStream } from '../internal/shim-types';
 import { Stream } from '../streaming';
 import OpenAI from '../index';
 import { ParsedChatCompletion } from '../resources/beta/chat/completions';
@@ -30,6 +29,7 @@ import {
   shouldParseToolCall,
 } from '../lib/parser';
 import { partialParse } from '../_vendor/partial-json-parser/parser';
+import { RequestOptions } from '../internal/request-options';
 
 export interface ContentDeltaEvent {
   delta: string;
@@ -158,7 +158,7 @@ export class ChatCompletionStream<ParsedT = null>
   static createChatCompletion<ParsedT>(
     client: OpenAI,
     params: ChatCompletionStreamParams,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): ChatCompletionStream<ParsedT> {
     const runner = new ChatCompletionStream<ParsedT>(params as ChatCompletionCreateParamsStreaming);
     runner._run(() =>
@@ -368,7 +368,7 @@ export class ChatCompletionStream<ParsedT = null>
   protected override async _createChatCompletion(
     client: OpenAI,
     params: ChatCompletionCreateParams,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ParsedChatCompletion<ParsedT>> {
     super._createChatCompletion;
     const signal = options?.signal;
@@ -394,7 +394,7 @@ export class ChatCompletionStream<ParsedT = null>
 
   protected async _fromReadableStream(
     readableStream: ReadableStream,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ChatCompletion> {
     const signal = options?.signal;
     if (signal) {

src/lib/ChatCompletionStreamingRunner.ts

@@ -3,7 +3,7 @@ import {
   type ChatCompletionCreateParamsStreaming,
 } from '../resources/chat/completions';
 import { RunnerOptions, type AbstractChatCompletionRunnerEvents } from './AbstractChatCompletionRunner';
-import { type ReadableStream } from '../_shims/index';
+import { type ReadableStream } from '../internal/shim-types';
 import { RunnableTools, type BaseFunctionsArgs, type RunnableFunctions } from './RunnableFunction';
 import { ChatCompletionSnapshot, ChatCompletionStream } from './ChatCompletionStream';
 import OpenAI from '../index';

src/pagination.ts

@@ -3,7 +3,7 @@
 import type { OpenAI } from './client';
 import { OpenAIError } from './error';
 import { FinalRequestOptions } from './internal/request-options';
-import { defaultParseResponse } from './internal/parse';
+import { defaultParseResponse, WithRequestID } from './internal/parse';
 import { APIPromise } from './api-promise';
 import { type APIResponseProps } from './internal/parse';
 import { maybeObj } from './internal/utils/values';
@@ -87,7 +87,13 @@ export class PagePromise<
   ) {
     super(
       request,
-      async (props) => new Page(client, props.response, await defaultParseResponse(props), props.options),
+      async (props) =>
+        new Page(
+          client,
+          props.response,
+          await defaultParseResponse(props),
+          props.options,
+        ) as WithRequestID<PageClass>,
     );
   }