adk-typescript/dist/models/LlmResponse.js

TypeScript port of Google's Agent Development Kit (ADK)

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LlmResponse = void 0;
/**
 * LLM response class that provides the first candidate response from the model
 * if available. Otherwise, returns error code and message.
 */
class LlmResponse {
    /**
     * Creates a new LlmResponse instance.
     * @param options Configuration options for the response
     */
    constructor(options = {}) {
        this.content = options.content;
        this.groundingMetadata = options.groundingMetadata;
        this.partial = options.partial;
        this.turnComplete = options.turnComplete;
        this.errorCode = options.errorCode;
        this.errorMessage = options.errorMessage;
        this.interrupted = options.interrupted;
        this.customMetadata = options.customMetadata;
    }
    /**
     * Creates an LlmResponse from a GenerateContentResponse.
     * @param generateContentResponse The GenerateContentResponse to create the LlmResponse from.
     * @returns The LlmResponse.
     */
    static create(generateContentResponse) {
        // Check if the response is empty or undefined
        if (!generateContentResponse || Object.keys(generateContentResponse).length === 0) {
            console.warn('Received empty response from the LLM API');
            return new LlmResponse({
                content: {
                    role: 'model',
                    parts: [{ text: 'I encountered an issue processing your request. Please try again.' }]
                },
                errorCode: 'EMPTY_RESPONSE',
                errorMessage: 'Empty response received from the LLM API.'
            });
        }
        if (generateContentResponse.candidates && generateContentResponse.candidates.length > 0) {
            const candidate = generateContentResponse.candidates[0];
            if (candidate.content && candidate.content.parts && candidate.content.parts.length > 0) {
                return new LlmResponse({
                    content: candidate.content,
                    groundingMetadata: candidate.grounding_metadata
                });
            }
            else {
                return new LlmResponse({
                    errorCode: candidate.finish_reason,
                    errorMessage: candidate.finish_message
                });
            }
        }
        else if (generateContentResponse.prompt_feedback) {
            const promptFeedback = generateContentResponse.prompt_feedback;
            return new LlmResponse({
                errorCode: promptFeedback.block_reason,
                errorMessage: promptFeedback.block_reason_message
            });
        }
        else {
            return new LlmResponse({
                errorCode: 'UNKNOWN_ERROR',
                errorMessage: 'Unknown error.'
            });
        }
    }
    /**
     * Checks if this response has an error.
     * @returns True if this response has an error, false otherwise.
     */
    hasError() {
        return this.errorCode !== undefined && this.errorCode !== null;
    }
    /**
     * Gets the text content of this response, if available.
     * @returns The text content as a string, or undefined if not available.
     */
    getText() {
        if (!this.content || !this.content.parts) {
            return undefined;
        }
        return this.content.parts
            .filter(part => part.text !== undefined)
            .map(part => part.text)
            .join('');
    }
    /**
     * Creates a copy of this LlmResponse with the given partial flag.
     * @param partial The partial flag value.
     * @returns A new LlmResponse with the updated partial flag.
     */
    withPartial(partial) {
        return new LlmResponse({
            content: this.content,
            groundingMetadata: this.groundingMetadata,
            partial,
            turnComplete: this.turnComplete,
            errorCode: this.errorCode,
            errorMessage: this.errorMessage,
            interrupted: this.interrupted,
            customMetadata: this.customMetadata
        });
    }
    /**
     * Creates a copy of this LlmResponse with the given turn complete flag.
     * @param turnComplete The turn complete flag value.
     * @returns A new LlmResponse with the updated turn complete flag.
     */
    withTurnComplete(turnComplete) {
        return new LlmResponse({
            content: this.content,
            groundingMetadata: this.groundingMetadata,
            partial: this.partial,
            turnComplete,
            errorCode: this.errorCode,
            errorMessage: this.errorMessage,
            interrupted: this.interrupted,
            customMetadata: this.customMetadata
        });
    }
    /**
     * Creates a copy of this LlmResponse with the given interrupted flag.
     * @param interrupted The interrupted flag value.
     * @returns A new LlmResponse with the updated interrupted flag.
     */
    withInterrupted(interrupted) {
        return new LlmResponse({
            content: this.content,
            groundingMetadata: this.groundingMetadata,
            partial: this.partial,
            turnComplete: this.turnComplete,
            errorCode: this.errorCode,
            errorMessage: this.errorMessage,
            interrupted,
            customMetadata: this.customMetadata
        });
    }
    /**
     * Creates a copy of this LlmResponse with the given custom metadata.
     * @param customMetadata The custom metadata.
     * @returns A new LlmResponse with the updated custom metadata.
     */
    withCustomMetadata(customMetadata) {
        return new LlmResponse({
            content: this.content,
            groundingMetadata: this.groundingMetadata,
            partial: this.partial,
            turnComplete: this.turnComplete,
            errorCode: this.errorCode,
            errorMessage: this.errorMessage,
            interrupted: this.interrupted,
            customMetadata
        });
    }
}
exports.LlmResponse = LlmResponse;