langchain.js
    Preparing search index...

    Type Alias UsageMetadata

    Usage metadata for a message, such as token counts.

    type UsageMetadata = {
        input_cost?: number;
        input_cost_details?: Record<string, unknown>;
        input_token_details?: InputTokenDetails;
        input_tokens: number;
        output_cost?: number;
        output_cost_details?: Record<string, unknown>;
        output_token_details?: OutputTokenDetails;
        output_tokens: number;
        total_cost?: number;
        total_tokens: number;
    }
    Index

    Properties

    input_cost? input_cost_details? input_token_details? input_tokens output_cost? output_cost_details? output_token_details? output_tokens total_cost? total_tokens

    Properties

    input_cost?: number

    The cost of the input tokens.

    input_cost_details?: Record<string, unknown>

    The cost details of the input tokens.

    input_token_details?: InputTokenDetails

    Breakdown of input token counts.

    Does not need to sum to full input token count. Does not need to have all keys.

    input_tokens: number

    Count of input (or prompt) tokens. Sum of all input token types.

    output_cost?: number

    The cost of the output tokens.

    output_cost_details?: Record<string, unknown>

    The cost details of the output tokens.

    output_token_details?: OutputTokenDetails

    Breakdown of output token counts.

    Does not need to sum to full output token count. Does not need to have all keys.

    output_tokens: number

    Count of output (or completion) tokens. Sum of all output token types.

    total_cost?: number

    The total cost of the tokens.

    total_tokens: number

    Total token count. Sum of input_tokens + output_tokens.

    Settings

    Member Visibility

    On This Page

    Properties