31 lines
1.8 KiB
TypeScript
31 lines
1.8 KiB
TypeScript
|
export interface OpenAIEndpointConfig {
|
||
|
|
azureOpenAIApiDeploymentName?: string;
|
||
|
|
azureOpenAIApiInstanceName?: string;
|
||
|
|
azureOpenAIApiKey?: string;
|
||
|
|
azureOpenAIBasePath?: string;
|
||
|
|
baseURL?: 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.
|
||
|
|
* @property {string} config.azureOpenAIApiKey - The API Key for Azure OpenAI.
|
||
|
|
* @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI.
|
||
|
|
* @property {string} config.baseURL - Some other custom base path URL.
|
||
|
|
*
|
||
|
|
* 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 `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.
|
||
|
|
*/
|
||
|
|
export declare function getEndpoint(config: OpenAIEndpointConfig): string | undefined;
|