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

Typescript client for the Hugging Face Inference Providers and Inference Endpoints

import type { ChatCompletionInput, ChatCompletionStreamOutput } from "@huggingface/tasks";
import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
import { getProviderHelper } from "../../lib/getProviderHelper.js";
import type { BaseArgs, Options } from "../../types.js";
import { innerStreamingRequest } from "../../utils/request.js";

/**
 * Use to continue text from a prompt. Same as `textGeneration` but returns generator that can be read one token at a time
 */
export async function* chatCompletionStream(
	args: BaseArgs & ChatCompletionInput,
	options?: Options
): AsyncGenerator<ChatCompletionStreamOutput> {
	const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
	const providerHelper = getProviderHelper(provider, "conversational");
	yield* innerStreamingRequest<ChatCompletionStreamOutput>(args, providerHelper, {
		...options,
		task: "conversational",
	});
}