Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
import type { AzureOptions } from '~/types';
/**
* Sanitizes the model name to be used in the URL by removing or replacing disallowed characters.
* @param modelName - The model name to be sanitized.
* @returns The sanitized model name.
*/
export const sanitizeModelName = (modelName: string): string => {
// Replace periods with empty strings and other disallowed characters as needed.
return modelName.replace(/\./g, '');
};
/**
* Generates the Azure OpenAI API endpoint URL.
* @param params - The parameters object.
* @param params.azureOpenAIApiInstanceName - The Azure OpenAI API instance name.
* @param params.azureOpenAIApiDeploymentName - The Azure OpenAI API deployment name.
* @returns The complete endpoint URL for the Azure OpenAI API.
*/
export const genAzureEndpoint = ({
azureOpenAIApiInstanceName,
azureOpenAIApiDeploymentName,
}: {
azureOpenAIApiInstanceName: string;
azureOpenAIApiDeploymentName: string;
}): string => {
// Support both old (.openai.azure.com) and new (.cognitiveservices.azure.com) endpoint formats
// If instanceName already includes a full domain, use it as-is
if (azureOpenAIApiInstanceName.includes('.azure.com')) {
return `https://${azureOpenAIApiInstanceName}/openai/deployments/${azureOpenAIApiDeploymentName}`;
}
// Legacy format for backward compatibility
return `https://${azureOpenAIApiInstanceName}.openai.azure.com/openai/deployments/${azureOpenAIApiDeploymentName}`;
};
/**
* Retrieves the Azure OpenAI API credentials from environment variables.
* @returns An object containing the Azure OpenAI API credentials.
*/
export const getAzureCredentials = (): AzureOptions => {
return {
azureOpenAIApiKey: process.env.AZURE_API_KEY ?? process.env.AZURE_OPENAI_API_KEY,
azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME,
azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME,
azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION,
};
};
/**
* Constructs a URL by replacing placeholders in the baseURL with values from the azure object.
* It specifically looks for '${INSTANCE_NAME}' and '${DEPLOYMENT_NAME}' within the baseURL and replaces
* them with 'azureOpenAIApiInstanceName' and 'azureOpenAIApiDeploymentName' from the azure object.
* If the respective azure property is not provided, the placeholder is replaced with an empty string.
*
* @param params - The parameters object.
* @param params.baseURL - The baseURL to inspect for replacement placeholders.
* @param params.azureOptions - The azure options object containing the instance and deployment names.
* @returns The complete baseURL with credentials injected for the Azure OpenAI API.
*/
export function constructAzureURL({
baseURL,
azureOptions,
}: {
baseURL: string;
azureOptions?: AzureOptions;
}): string {
let finalURL = baseURL;
// Replace INSTANCE_NAME and DEPLOYMENT_NAME placeholders with actual values if available
if (azureOptions) {
finalURL = finalURL.replace('${INSTANCE_NAME}', azureOptions.azureOpenAIApiInstanceName ?? '');
finalURL = finalURL.replace(
'${DEPLOYMENT_NAME}',
azureOptions.azureOpenAIApiDeploymentName ?? '',
);
}
return finalURL;
}
export function isCanonicalAzureURL(baseURL: string): boolean {
try {
return /\.(?:openai|cognitiveservices|services\.ai)\.azure\.(?:com|us|cn)$/i.test(
new URL(baseURL).hostname,
);
} catch {
return false;
}
}
function isAzureRootPath(pathname: string): boolean {
return /^\/(?:openai(?:\/v1)?\/?|v1\/?)?$/.test(pathname);
}
/** An instance name that is already a full Azure hostname, which `genAzureEndpoint` also accepts. */
function getAzureInstanceHost(instanceName?: string): string | undefined {
return instanceName && isCanonicalAzureURL(`https://${instanceName}`) ? instanceName : undefined;
}
/**
* The deployments path for a full-hostname instance without a base URL. A resource name needs
* none: the client derives `<name>.openai.azure.com` itself, which a full hostname would double.
*/
export function constructAzureInstanceBasePath(azureOptions: AzureOptions): string | undefined {
const host = getAzureInstanceHost(azureOptions.azureOpenAIApiInstanceName);
return host ? `https://${host}/openai/deployments` : undefined;
}
export function constructAzureChatBasePath(baseURL: string, azureOptions: AzureOptions): string {
const resolvedURL = constructAzureURL({ baseURL, azureOptions });
if (isCanonicalAzureURL(resolvedURL)) {
const url = new URL(resolvedURL);
if (isAzureRootPath(url.pathname)) {
return `${url.origin}/openai/deployments`;
}
}
return resolvedURL.split(`/${azureOptions.azureOpenAIApiDeploymentName}`)[0];
}
/** Azure permits the deployment to be supplied entirely by the configured base URL. */
export function getAzureDeploymentName(
baseURL?: string | null,
azureOptions?: AzureOptions,
): string | undefined {
if (!baseURL) {
return undefined;
}
try {
const url = new URL(constructAzureURL({ baseURL, azureOptions }));
const deployment = url.pathname.match(/\/deployments\/([^/]+)/)?.[1];
return deployment ? decodeURIComponent(deployment) : undefined;
} catch {
return undefined;
}
}
export function constructAzureResponsesURL(
baseURL: string | null | undefined,
azureOptions: AzureOptions,
): URL {
const instanceName = azureOptions.azureOpenAIApiInstanceName ?? '';
const instanceHost = getAzureInstanceHost(instanceName) ?? `${instanceName}.openai.azure.com`;
const resolvedURL = baseURL
? constructAzureURL({ baseURL, azureOptions })
: `https://${instanceHost}/openai/v1`;
const url = new URL(resolvedURL);
url.pathname = url.pathname.replace(/\/deployments(?:\/.*)?$/, '/v1');
if (isCanonicalAzureURL(resolvedURL) && isAzureRootPath(url.pathname)) {
url.pathname = '/openai/v1';
}
return url;
}