| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
- var _a;
- import * as qs from "./internal/qs/index.mjs";
- import * as Core from "./core.mjs";
- import * as Errors from "./error.mjs";
- import * as Pagination from "./pagination.mjs";
- import * as Uploads from "./uploads.mjs";
- import * as API from "./resources/index.mjs";
- import { Batches, BatchesPage, } from "./resources/batches.mjs";
- import { Completions, } from "./resources/completions.mjs";
- import { Embeddings, } from "./resources/embeddings.mjs";
- import { FileObjectsPage, Files, } from "./resources/files.mjs";
- import { Images, } from "./resources/images.mjs";
- import { Models, ModelsPage } from "./resources/models.mjs";
- import { Moderations, } from "./resources/moderations.mjs";
- import { Audio } from "./resources/audio/audio.mjs";
- import { Beta } from "./resources/beta/beta.mjs";
- import { Chat } from "./resources/chat/chat.mjs";
- import { ContainerListResponsesPage, Containers, } from "./resources/containers/containers.mjs";
- import { EvalListResponsesPage, Evals, } from "./resources/evals/evals.mjs";
- import { FineTuning } from "./resources/fine-tuning/fine-tuning.mjs";
- import { Graders } from "./resources/graders/graders.mjs";
- import { Responses } from "./resources/responses/responses.mjs";
- import { Uploads as UploadsAPIUploads, } from "./resources/uploads/uploads.mjs";
- import { VectorStoreSearchResponsesPage, VectorStores, VectorStoresPage, } from "./resources/vector-stores/vector-stores.mjs";
- import { ChatCompletionsPage, } from "./resources/chat/completions/completions.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.graders = new API.Graders(this);
- this.vectorStores = new API.VectorStores(this);
- this.beta = new API.Beta(this);
- this.batches = new API.Batches(this);
- this.uploads = new API.Uploads(this);
- this.responses = new API.Responses(this);
- this.evals = new API.Evals(this);
- this.containers = new API.Containers(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;
- OpenAI.Completions = Completions;
- OpenAI.Chat = Chat;
- OpenAI.ChatCompletionsPage = ChatCompletionsPage;
- OpenAI.Embeddings = Embeddings;
- OpenAI.Files = Files;
- OpenAI.FileObjectsPage = FileObjectsPage;
- OpenAI.Images = Images;
- OpenAI.Audio = Audio;
- OpenAI.Moderations = Moderations;
- OpenAI.Models = Models;
- OpenAI.ModelsPage = ModelsPage;
- OpenAI.FineTuning = FineTuning;
- OpenAI.Graders = Graders;
- OpenAI.VectorStores = VectorStores;
- OpenAI.VectorStoresPage = VectorStoresPage;
- OpenAI.VectorStoreSearchResponsesPage = VectorStoreSearchResponsesPage;
- OpenAI.Beta = Beta;
- OpenAI.Batches = Batches;
- OpenAI.BatchesPage = BatchesPage;
- OpenAI.Uploads = UploadsAPIUploads;
- OpenAI.Responses = Responses;
- OpenAI.Evals = Evals;
- OpenAI.EvalListResponsesPage = EvalListResponsesPage;
- OpenAI.Containers = Containers;
- OpenAI.ContainerListResponsesPage = ContainerListResponsesPage;
- /** 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.deploymentName = deployment;
- }
- buildRequest(options, props = {}) {
- 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.deploymentName || options.body['model'] || options.__metadata?.['model'];
- if (model !== undefined && !this.baseURL.includes('/deployments')) {
- options.path = `/deployments/${model}${options.path}`;
- }
- }
- return super.buildRequest(options, props);
- }
- 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',
- '/images/edits',
- ]);
- const API_KEY_SENTINEL = '<Missing Key>';
- export { toFile, fileFromPath } from "./uploads.mjs";
- export { OpenAIError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.mjs";
- export default OpenAI;
- //# sourceMappingURL=index.mjs.map
|