basant307/AI_Governance_Project

1import type { RequestInit } from "./internal/builtin-types.js";2import { FinalRequestOptions } from "./internal/request-options.js";3import { ClientOptions, OpenAI } from "./client.js";4import { NullableHeaders } from "./internal/headers.js";5/** API Client for interfacing with the Azure OpenAI API. */6export interface AzureClientOptions extends ClientOptions {7    /**8     * Defaults to process.env['OPENAI_API_VERSION'].9     */10    apiVersion?: string | undefined;11    /**12     * Your Azure endpoint, including the resource, e.g. `https://example-resource.azure.openai.com/`13     */14    endpoint?: string | undefined;15    /**16     * A model deployment, if given, sets the base client URL to include `/deployments/{deployment}`.17     * Note: this means you won't be able to use non-deployment endpoints. Not supported with Assistants APIs.18     */19    deployment?: string | undefined;20    /**21     * Defaults to process.env['AZURE_OPENAI_API_KEY'].22     */23    apiKey?: string | undefined;24    /**25     * A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory),26     * which will be invoked on every request.27     */28    azureADTokenProvider?: (() => Promise<string>) | undefined;29}30/** API Client for interfacing with the Azure OpenAI API. */31export declare class AzureOpenAI extends OpenAI {32    private _azureADTokenProvider;33    deploymentName: string | undefined;34    apiVersion: string;35    /**36     * API Client for interfacing with the Azure OpenAI API.37     *38     * @param {string | undefined} [opts.apiVersion=process.env['OPENAI_API_VERSION'] ?? undefined]39     * @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/`40     * @param {string | undefined} [opts.apiKey=process.env['AZURE_OPENAI_API_KEY'] ?? undefined]41     * @param {string | undefined} opts.deployment - A model deployment, if given, sets the base client URL to include `/deployments/{deployment}`.42     * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null]43     * @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/`.44     * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.45     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.46     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.47     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.48     * @param {Headers} opts.defaultHeaders - Default headers to include with every request to the API.49     * @param {DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.50     * @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.51     */52    constructor({ baseURL, apiKey, apiVersion, endpoint, deployment, azureADTokenProvider, dangerouslyAllowBrowser, ...opts }?: AzureClientOptions);53    buildRequest(options: FinalRequestOptions, props?: {54        retryCount?: number;55    }): Promise<{56        req: RequestInit & {57            headers: Headers;58        };59        url: string;60        timeout: number;61    }>;62    _getAzureADToken(): Promise<string | undefined>;63    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;64    protected prepareOptions(opts: FinalRequestOptions): Promise<void>;65}66//# sourceMappingURL=azure.d.ts.map