Spaces:
Sleeping
Sleeping
| //#region src/utils/azure.d.ts | |
| interface OpenAIEndpointConfig { | |
| azureOpenAIApiDeploymentName?: string; | |
| azureOpenAIApiInstanceName?: string; | |
| azureOpenAIApiKey?: string; | |
| azureADTokenProvider?: () => Promise<string>; | |
| azureOpenAIBasePath?: string; | |
| baseURL?: string | null; | |
| azureOpenAIEndpoint?: string; | |
| } | |
| /** | |
| * This function generates an endpoint URL for (Azure) OpenAI | |
| * based on the configuration parameters provided. | |
| * | |
| * @param {OpenAIEndpointConfig} config - The configuration object for the (Azure) endpoint. | |
| * | |
| * @property {string} config.azureOpenAIApiDeploymentName - The deployment name of Azure OpenAI. | |
| * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI, e.g. `example-resource`. | |
| * @property {string} config.azureOpenAIApiKey - The API Key for Azure OpenAI. | |
| * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI, e.g. `https://example-resource.azure.openai.com/openai/deployments/`. | |
| * @property {string} config.baseURL - Some other custom base path URL. | |
| * @property {string} config.azureOpenAIEndpoint - The endpoint for the Azure OpenAI instance, e.g. `https://example-resource.azure.openai.com/`. | |
| * | |
| * The function operates as follows: | |
| * - If both `azureOpenAIBasePath` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIBasePath}/${azureOpenAIApiDeploymentName}`). | |
| * - If both `azureOpenAIEndpoint` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIEndpoint}/openai/deployments/${azureOpenAIApiDeploymentName}`). | |
| * - If `azureOpenAIApiKey` is provided, it checks for `azureOpenAIApiInstanceName` and `azureOpenAIApiDeploymentName` and throws an error if any of these is missing. If both are provided, it generates an URL incorporating these parameters. | |
| * - If none of the above conditions are met, return any custom `baseURL`. | |
| * - The function returns the generated URL as a string, or undefined if no custom paths are specified. | |
| * | |
| * @throws Will throw an error if the necessary parameters for generating the URL are missing. | |
| * | |
| * @returns {string | undefined} The generated (Azure) OpenAI endpoint URL. | |
| */ | |
| declare function getEndpoint(config: OpenAIEndpointConfig): string | null | undefined; | |
| type HeaderValue = string | undefined | null; | |
| type HeadersLike = Headers | readonly HeaderValue[][] | Record<string, HeaderValue | readonly HeaderValue[]> | undefined | null | { | |
| values: Headers; | |
| [key: string]: unknown; | |
| }; | |
| declare function isHeaders(headers: unknown): headers is Headers; | |
| /** | |
| * Normalizes various header formats into a consistent Record format. | |
| * | |
| * This function accepts headers in multiple formats and converts them to a | |
| * Record<string, HeaderValue | readonly HeaderValue[]> for consistent handling. | |
| * | |
| * @param headers - The headers to normalize. Can be: | |
| * - A Headers instance | |
| * - An array of [key, value] pairs | |
| * - A plain object with string keys | |
| * - A NullableHeaders-like object with a 'values' property containing Headers | |
| * - null or undefined | |
| * @returns A normalized Record containing the header key-value pairs | |
| * | |
| * @example | |
| * ```ts | |
| * // With Headers instance | |
| * const headers1 = new Headers([['content-type', 'application/json']]); | |
| * const normalized1 = normalizeHeaders(headers1); | |
| * | |
| * // With plain object | |
| * const headers2 = { 'content-type': 'application/json' }; | |
| * const normalized2 = normalizeHeaders(headers2); | |
| * | |
| * // With array of pairs | |
| * const headers3 = [['content-type', 'application/json']]; | |
| * const normalized3 = normalizeHeaders(headers3); | |
| * ``` | |
| */ | |
| declare function normalizeHeaders(headers: HeadersLike): Record<string, HeaderValue | readonly HeaderValue[]>; | |
| declare function getFormattedEnv(): string; | |
| declare function getHeadersWithUserAgent(headers: HeadersLike, isAzure?: boolean, version?: string): Record<string, string>; | |
| //#endregion | |
| export { HeadersLike, OpenAIEndpointConfig, getEndpoint, getFormattedEnv, getHeadersWithUserAgent, isHeaders, normalizeHeaders }; | |
| //# sourceMappingURL=azure.d.ts.map |