@huggingface/inference/src/tasks/nlp/chatCompletion.ts

Typescript client for the Hugging Face Inference Providers and Inference Endpoints

import type { ChatCompletionInput, ChatCompletionOutput } from "@huggingface/tasks";
import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
import { getProviderHelper } from "../../lib/getProviderHelper.js";
import type { BaseArgs, Options } from "../../types.js";
import { innerRequest } from "../../utils/request.js";
import type { ConversationalTaskHelper, TaskProviderHelper } from "../../providers/providerHelper.js";
import { AutoRouterConversationalTask } from "../../providers/providerHelper.js";

/**
 * Use the chat completion endpoint to generate a response to a prompt, using OpenAI message completion API no stream
 */
export async function chatCompletion(
	args: BaseArgs & ChatCompletionInput,
	options?: Options
): Promise<ChatCompletionOutput> {
	let providerHelper: ConversationalTaskHelper & TaskProviderHelper;
	if (!args.provider || args.provider === "auto") {
		// Special case: we have a dedicated auto-router for conversational models. No need to fetch provider mapping.
		providerHelper = new AutoRouterConversationalTask();
	} else {
		const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
		providerHelper = getProviderHelper(provider, "conversational");
	}
	const { data: response } = await innerRequest<ChatCompletionOutput>(args, providerHelper, {
		...options,
		task: "conversational",
	});
	return providerHelper.getResponse(response);
}