Hugging Face Transformers React - v1.2.0
    Preparing search index...

    Interface ChatCompletionResult

    Result from a WebLLM chat completion request. Compatible with OpenAI chat completion API format.

    const result = await chatCompletion(messages);
    console.log(result.choices[0].message.content);
    console.log(`Tokens used: ${result.usage?.total_tokens}`);
    interface ChatCompletionResult {
        choices: { message: ChatMessage; finish_reason?: string }[];
        usage?: {
            prompt_tokens: number;
            completion_tokens: number;
            total_tokens: number;
        };
    }
    Index

    Properties

    choices usage?

    Properties

    choices: { message: ChatMessage; finish_reason?: string }[]

    Array of completion choices (typically contains one item)

    Type declaration

    • message: ChatMessage

      The generated message

    • Optionalfinish_reason?: string

      Reason the completion finished: 'stop', 'length', etc.

    usage?: {
        prompt_tokens: number;
        completion_tokens: number;
        total_tokens: number;
    }

    Token usage statistics

    Type declaration

    • prompt_tokens: number

      Number of tokens in the prompt

    • completion_tokens: number

      Number of tokens in the completion

    • total_tokens: number

      Total tokens used (prompt + completion)

    Settings

    Member Visibility

    On This Page

    Properties