@sap-ai-sdk/orchestration/dist/orchestration-stream-response.js

SAP Cloud SDK for AI is the official Software Development Kit (SDK) for **SAP AI Core**, **SAP Generative AI Hub**, and **Orchestration Service**.

/**
 * Orchestration stream response.
 */
export class OrchestrationStreamResponse {
    _openStream = true;
    _data = {};
    _stream;
    /**
     * Gets the token usage for the response.
     * @returns The token usage for the response.
     */
    getTokenUsage() {
        if (this.isStreamOpen()) {
            return;
        }
        return this._data.final_result?.usage;
    }
    /**
     * Gets the finish reason for a specific choice index.
     * @param choiceIndex - The index of the choice to get the finish reason for.
     * @returns The finish reason for the specified choice index.
     */
    getFinishReason(choiceIndex = 0) {
        if (this.isStreamOpen()) {
            return;
        }
        return this.findChoiceByIndex(choiceIndex)?.finish_reason;
    }
    /**
     * Parses the orchestration response and returns the content.
     * If the response was filtered, an error is thrown.
     * @param choiceIndex - The index of the choice to parse.
     * @returns The message content.
     */
    getContent(choiceIndex = 0) {
        if (this.isStreamOpen()) {
            return;
        }
        const choice = this.findChoiceByIndex(choiceIndex);
        return choice?.message?.content;
    }
    /**
     * Parses the orchestration response and returns the tool calls generated by the model.
     * @param choiceIndex - The index of the choice to parse.
     * @returns The message tool calls.
     */
    getToolCalls(choiceIndex = 0) {
        if (this.isStreamOpen()) {
            return;
        }
        const choice = this.findChoiceByIndex(choiceIndex);
        return choice?.message?.tool_calls;
    }
    /**
     * Parses the orchestration response and returns the refusal message generated by the model.
     * @param choiceIndex - The index of the choice to parse.
     * @returns The refusal string.
     */
    getRefusal(choiceIndex = 0) {
        if (this.isStreamOpen()) {
            return;
        }
        const choice = this.findChoiceByIndex(choiceIndex);
        return choice?.message?.refusal;
    }
    /**
     * Messages that can be used for subsequent prompts as message history.
     * @param choiceIndex - The index of the choice to parse.
     * @returns A list of all messages.
     */
    getAllMessages(choiceIndex = 0) {
        if (this.isStreamOpen()) {
            return;
        }
        const messages = this._data.intermediate_results?.templating ?? [];
        const content = this.findChoiceByIndex(choiceIndex)?.message;
        return content ? [...messages, content] : messages;
    }
    /**
     * Gets the assistant message from the response.
     * @param choiceIndex - The index of the choice to use (default is 0).
     * @returns The assistant message.
     */
    getAssistantMessage(choiceIndex = 0) {
        if (this.isStreamOpen()) {
            return;
        }
        return this.findChoiceByIndex(choiceIndex)?.message;
    }
    /**
     * Gets the intermediate results from the orchestration response.
     * @returns The intermediate results.
     */
    getIntermediateResults() {
        if (this.isStreamOpen()) {
            return;
        }
        return this._data.intermediate_results;
    }
    /**
     * Parses the response and returns the choice by index.
     * @param index - The index of the choice to find.
     * @returns An {@link LLMChoice} object associated with the index.
     */
    findChoiceByIndex(index) {
        if (this.isStreamOpen()) {
            return;
        }
        return this.getChoices().find((c) => c.index === index);
    }
    get stream() {
        if (!this._stream) {
            throw new Error('Response stream is undefined.');
        }
        return this._stream;
    }
    getChoices() {
        return this._data.final_result?.choices ?? [];
    }
    isStreamOpen() {
        if (this._openStream) {
            throw Error('The stream is still open, the requested data is not available yet. Please wait until the stream is closed.');
        }
        return this._openStream;
    }
    /**
     * @internal
     */
    set stream(stream) {
        this._stream = stream;
    }
}
//# sourceMappingURL=orchestration-stream-response.js.map