131 lines
		
	
	
		
			6.7 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			131 lines
		
	
	
		
			6.7 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| "use strict";
 | |
| Object.defineProperty(exports, "__esModule", { value: true });
 | |
| exports.AzureOpenAI = void 0;
 | |
| const tslib_1 = require("./internal/tslib.js");
 | |
| const Errors = tslib_1.__importStar(require("./error.js"));
 | |
| const utils_1 = require("./internal/utils.js");
 | |
| const client_1 = require("./client.js");
 | |
| const headers_1 = require("./internal/headers.js");
 | |
| /** API Client for interfacing with the Azure OpenAI API. */
 | |
| class AzureOpenAI extends client_1.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 {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 {Headers} opts.defaultHeaders - Default headers to include with every request to the API.
 | |
|      * @param {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 = (0, utils_1.readEnv)('OPENAI_BASE_URL'), apiKey = (0, utils_1.readEnv)('AZURE_OPENAI_API_KEY'), apiVersion = (0, utils_1.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;
 | |
|     }
 | |
|     async buildRequest(options, props = {}) {
 | |
|         if (_deployments_endpoints.has(options.path) && options.method === 'post' && options.body !== undefined) {
 | |
|             if (!(0, utils_1.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;
 | |
|     }
 | |
|     async authHeaders(opts) {
 | |
|         return;
 | |
|     }
 | |
|     async prepareOptions(opts) {
 | |
|         opts.headers = (0, headers_1.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.values.get('Authorization') || opts.headers.values.get('api-key')) {
 | |
|             return super.prepareOptions(opts);
 | |
|         }
 | |
|         const token = await this._getAzureADToken();
 | |
|         if (token) {
 | |
|             opts.headers.values.set('Authorization', `Bearer ${token}`);
 | |
|         }
 | |
|         else if (this.apiKey !== API_KEY_SENTINEL) {
 | |
|             opts.headers.values.set('api-key', this.apiKey);
 | |
|         }
 | |
|         else {
 | |
|             throw new Errors.OpenAIError('Unable to handle auth');
 | |
|         }
 | |
|         return super.prepareOptions(opts);
 | |
|     }
 | |
| }
 | |
| exports.AzureOpenAI = AzureOpenAI;
 | |
| const _deployments_endpoints = new Set([
 | |
|     '/completions',
 | |
|     '/chat/completions',
 | |
|     '/embeddings',
 | |
|     '/audio/transcriptions',
 | |
|     '/audio/translations',
 | |
|     '/audio/speech',
 | |
|     '/images/generations',
 | |
|     '/batches',
 | |
|     '/images/edits',
 | |
| ]);
 | |
| const API_KEY_SENTINEL = '<Missing Key>';
 | |
| //# sourceMappingURL=azure.js.map
 |