@artinet/sdk
Version:
A TypeScript SDK for building collaborative AI agents.
49 lines (48 loc) • 1.92 kB
TypeScript
/**
* Copyright 2025 The Artinet Project
* SPDX-License-Identifier: Apache-2.0
*/
import { A2A } from "../../../types/index.js";
/**
* Extracts and aggregates the text, file, and data contents from an array of Part objects.
*
* @param parts - An array of Part objects, which may include text, file, or data kinds.
* @returns An object containing:
* - text: Concatenated string of all text parts.
* - file: Array of file contents from file parts.
* - data: Array of data contents from data parts.
*
* @remarks
* This utility is used to normalize and access the payloads of message parts
* in a structured way for downstream processing.
*/
export declare const getParts: (parts: A2A.Part[]) => {
text: A2A.TextPart["text"];
file: A2A.FilePart["file"][];
data: A2A.DataPart["data"][];
};
/**
* Extracts and aggregates the text, file, and data payloads from a Message's parts array.
*
* @param message - The Message object containing an array of Part objects (text, file, or data).
* @returns An object with the following properties:
* - text: A single string containing the concatenated text from all text parts.
* - file: An array of file payloads from all file parts.
* - data: An array of data payloads from all data parts.
*
* @remarks
* This utility function is intended to simplify downstream processing by normalizing
* the payloads of a Message's parts into a structured object. It is especially useful
* when handling user input or agent responses that may include multiple content types.
*
* @example
* const payload = getPayload(message);
* console.log(payload.text); // "Hello world"
* console.log(payload.file); // [<file1>, <file2>]
* console.log(payload.data); // [<data1>, <data2>]
*/
export declare const getPayload: (message: A2A.Message) => {
text: A2A.TextPart["text"];
file: A2A.FilePart["file"][];
data: A2A.DataPart["data"][];
};