// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. var _a; import * as Errors from "./error.mjs"; import * as Uploads from "./uploads.mjs"; import * as qs from "./internal/qs/index.mjs"; import * as Core from "./core.mjs"; import * as Pagination from "./pagination.mjs"; import * as API from "./resources/index.mjs"; /** * API Client for interfacing with the OpenAI API. */ export class OpenAI extends Core.APIClient { /** * API Client for interfacing with the OpenAI API. * * @param {string | undefined} [opts.apiKey=process.env['OPENAI_API_KEY'] ?? undefined] * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null] * @param {string | null | undefined} [opts.project=process.env['OPENAI_PROJECT_ID'] ?? null] * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL'] ?? https://api.openai.com/v1] - Override the default base URL for the API. * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. */ constructor({ baseURL = Core.readEnv('OPENAI_BASE_URL'), apiKey = Core.readEnv('OPENAI_API_KEY'), organization = Core.readEnv('OPENAI_ORG_ID') ?? null, project = Core.readEnv('OPENAI_PROJECT_ID') ?? null, ...opts } = {}) { if (apiKey === undefined) { throw new Errors.OpenAIError("The OPENAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the OpenAI client with an apiKey option, like new OpenAI({ apiKey: 'My API Key' })."); } const options = { apiKey, organization, project, ...opts, baseURL: baseURL || `https://api.openai.com/v1`, }; if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) { throw new Errors.OpenAIError("It looks like you're running in a browser-like environment.\n\nThis is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew OpenAI({ apiKey, dangerouslyAllowBrowser: true });\n\nhttps://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety\n"); } super({ baseURL: options.baseURL, timeout: options.timeout ?? 600000 /* 10 minutes */, httpAgent: options.httpAgent, maxRetries: options.maxRetries, fetch: options.fetch, }); this.completions = new API.Completions(this); this.chat = new API.Chat(this); this.embeddings = new API.Embeddings(this); this.files = new API.Files(this); this.images = new API.Images(this); this.audio = new API.Audio(this); this.moderations = new API.Moderations(this); this.models = new API.Models(this); this.fineTuning = new API.FineTuning(this); this.beta = new API.Beta(this); this.batches = new API.Batches(this); this.uploads = new API.Uploads(this); this._options = options; this.apiKey = apiKey; this.organization = organization; this.project = project; } defaultQuery() { return this._options.defaultQuery; } defaultHeaders(opts) { return { ...super.defaultHeaders(opts), 'OpenAI-Organization': this.organization, 'OpenAI-Project': this.project, ...this._options.defaultHeaders, }; } authHeaders(opts) { return { Authorization: `Bearer ${this.apiKey}` }; } stringifyQuery(query) { return qs.stringify(query, { arrayFormat: 'brackets' }); } } _a = OpenAI; OpenAI.OpenAI = _a; OpenAI.DEFAULT_TIMEOUT = 600000; // 10 minutes OpenAI.OpenAIError = Errors.OpenAIError; OpenAI.APIError = Errors.APIError; OpenAI.APIConnectionError = Errors.APIConnectionError; OpenAI.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError; OpenAI.APIUserAbortError = Errors.APIUserAbortError; OpenAI.NotFoundError = Errors.NotFoundError; OpenAI.ConflictError = Errors.ConflictError; OpenAI.RateLimitError = Errors.RateLimitError; OpenAI.BadRequestError = Errors.BadRequestError; OpenAI.AuthenticationError = Errors.AuthenticationError; OpenAI.InternalServerError = Errors.InternalServerError; OpenAI.PermissionDeniedError = Errors.PermissionDeniedError; OpenAI.UnprocessableEntityError = Errors.UnprocessableEntityError; OpenAI.toFile = Uploads.toFile; OpenAI.fileFromPath = Uploads.fileFromPath; export const { OpenAIError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } = Errors; export var toFile = Uploads.toFile; export var fileFromPath = Uploads.fileFromPath; (function (OpenAI) { OpenAI.Page = Pagination.Page; OpenAI.CursorPage = Pagination.CursorPage; OpenAI.Completions = API.Completions; OpenAI.Chat = API.Chat; OpenAI.Embeddings = API.Embeddings; OpenAI.Files = API.Files; OpenAI.FileObjectsPage = API.FileObjectsPage; OpenAI.Images = API.Images; OpenAI.Audio = API.Audio; OpenAI.Moderations = API.Moderations; OpenAI.Models = API.Models; OpenAI.ModelsPage = API.ModelsPage; OpenAI.FineTuning = API.FineTuning; OpenAI.Beta = API.Beta; OpenAI.Batches = API.Batches; OpenAI.BatchesPage = API.BatchesPage; OpenAI.Uploads = API.Uploads; })(OpenAI || (OpenAI = {})); /** API Client for interfacing with the Azure OpenAI API. */ export class AzureOpenAI extends OpenAI { /** * API Client for interfacing with the Azure OpenAI API. * * @param {string | undefined} [opts.apiVersion=process.env['OPENAI_API_VERSION'] ?? undefined] * @param {string | undefined} [opts.endpoint=process.env['AZURE_OPENAI_ENDPOINT'] ?? undefined] - Your Azure endpoint, including the resource, e.g. `https://example-resource.azure.openai.com/` * @param {string | undefined} [opts.apiKey=process.env['AZURE_OPENAI_API_KEY'] ?? undefined] * @param {string | undefined} opts.deployment - A model deployment, if given, sets the base client URL to include `/deployments/{deployment}`. * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null] * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL']] - Sets the base URL for the API, e.g. `https://example-resource.azure.openai.com/openai/`. * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. */ constructor({ baseURL = Core.readEnv('OPENAI_BASE_URL'), apiKey = Core.readEnv('AZURE_OPENAI_API_KEY'), apiVersion = Core.readEnv('OPENAI_API_VERSION'), endpoint, deployment, azureADTokenProvider, dangerouslyAllowBrowser, ...opts } = {}) { if (!apiVersion) { throw new Errors.OpenAIError("The OPENAI_API_VERSION environment variable is missing or empty; either provide it, or instantiate the AzureOpenAI client with an apiVersion option, like new AzureOpenAI({ apiVersion: 'My API Version' })."); } if (typeof azureADTokenProvider === 'function') { dangerouslyAllowBrowser = true; } if (!azureADTokenProvider && !apiKey) { throw new Errors.OpenAIError('Missing credentials. Please pass one of `apiKey` and `azureADTokenProvider`, or set the `AZURE_OPENAI_API_KEY` environment variable.'); } if (azureADTokenProvider && apiKey) { throw new Errors.OpenAIError('The `apiKey` and `azureADTokenProvider` arguments are mutually exclusive; only one can be passed at a time.'); } // define a sentinel value to avoid any typing issues apiKey ?? (apiKey = API_KEY_SENTINEL); opts.defaultQuery = { ...opts.defaultQuery, 'api-version': apiVersion }; if (!baseURL) { if (!endpoint) { endpoint = process.env['AZURE_OPENAI_ENDPOINT']; } if (!endpoint) { throw new Errors.OpenAIError('Must provide one of the `baseURL` or `endpoint` arguments, or the `AZURE_OPENAI_ENDPOINT` environment variable'); } baseURL = `${endpoint}/openai`; } else { if (endpoint) { throw new Errors.OpenAIError('baseURL and endpoint are mutually exclusive'); } } super({ apiKey, baseURL, ...opts, ...(dangerouslyAllowBrowser !== undefined ? { dangerouslyAllowBrowser } : {}), }); this.apiVersion = ''; this._azureADTokenProvider = azureADTokenProvider; this.apiVersion = apiVersion; this._deployment = deployment; } buildRequest(options) { if (_deployments_endpoints.has(options.path) && options.method === 'post' && options.body !== undefined) { if (!Core.isObj(options.body)) { throw new Error('Expected request body to be an object'); } const model = this._deployment || options.body['model']; if (model !== undefined && !this.baseURL.includes('/deployments')) { options.path = `/deployments/${model}${options.path}`; } } return super.buildRequest(options); } async _getAzureADToken() { if (typeof this._azureADTokenProvider === 'function') { const token = await this._azureADTokenProvider(); if (!token || typeof token !== 'string') { throw new Errors.OpenAIError(`Expected 'azureADTokenProvider' argument to return a string but it returned ${token}`); } return token; } return undefined; } authHeaders(opts) { return {}; } async prepareOptions(opts) { /** * 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']) { return super.prepareOptions(opts); } const token = await this._getAzureADToken(); opts.headers ?? (opts.headers = {}); if (token) { opts.headers['Authorization'] = `Bearer ${token}`; } else if (this.apiKey !== API_KEY_SENTINEL) { opts.headers['api-key'] = this.apiKey; } else { throw new Errors.OpenAIError('Unable to handle auth'); } return super.prepareOptions(opts); } } const _deployments_endpoints = new Set([ '/completions', '/chat/completions', '/embeddings', '/audio/transcriptions', '/audio/translations', '/audio/speech', '/images/generations', ]); const API_KEY_SENTINEL = ''; // ---------------------- End Azure ---------------------- export default OpenAI; //# sourceMappingURL=index.mjs.map