@letta-ai/letta-client 0.1.58 → 0.1.60

package/dist/api/resources/groups/client/Client.d.ts

@@ -0,0 +1,145 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Letta from "../../../index";
+export declare namespace Groups {
+    interface Options {
+        environment?: core.Supplier<environments.LettaEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<string | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Groups {
+    protected readonly _options: Groups.Options;
+    constructor(_options?: Groups.Options);
+    /**
+     * Fetch all multi-agent groups matching query.
+     *
+     * @param {Letta.ListGroupsRequest} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.listGroups()
+     */
+    listGroups(request?: Letta.ListGroupsRequest, requestOptions?: Groups.RequestOptions): Promise<Letta.Group[]>;
+    /**
+     * Create a new multi-agent group with the specified configuration.
+     *
+     * @param {Letta.CreateGroupRequest} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.createGroup({
+     *         body: {
+     *             agentIds: ["agent_ids"],
+     *             description: "description"
+     *         }
+     *     })
+     */
+    createGroup(request: Letta.CreateGroupRequest, requestOptions?: Groups.RequestOptions): Promise<Letta.Group>;
+    /**
+     * Create a new multi-agent group with the specified configuration.
+     *
+     * @param {Letta.UpsertGroupRequest} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.upsertGroup({
+     *         body: {
+     *             agentIds: ["agent_ids"],
+     *             description: "description"
+     *         }
+     *     })
+     */
+    upsertGroup(request: Letta.UpsertGroupRequest, requestOptions?: Groups.RequestOptions): Promise<Letta.Group>;
+    /**
+     * Delete a multi-agent group.
+     *
+     * @param {string} groupId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.deleteGroup("group_id")
+     */
+    deleteGroup(groupId: string, requestOptions?: Groups.RequestOptions): Promise<unknown>;
+    /**
+     * Retrieve message history for an agent.
+     *
+     * @param {string} groupId
+     * @param {Letta.ListGroupMessagesRequest} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.listGroupMessages("group_id")
+     */
+    listGroupMessages(groupId: string, request?: Letta.ListGroupMessagesRequest, requestOptions?: Groups.RequestOptions): Promise<Letta.LettaMessageUnion[]>;
+    /**
+     * Process a user message and return the group's response.
+     * This endpoint accepts a message from a user and processes it through through agents in the group based on the specified pattern
+     *
+     * @param {string} groupId
+     * @param {Letta.SendGroupMessageRequest} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.sendGroupMessage("group_id", {
+     *         agentId: "agent_id",
+     *         body: {
+     *             messages: [{
+     *                     role: "user",
+     *                     content: "content"
+     *                 }]
+     *         }
+     *     })
+     */
+    sendGroupMessage(groupId: string, request: Letta.SendGroupMessageRequest, requestOptions?: Groups.RequestOptions): Promise<Letta.LettaResponse>;
+    /**
+     * Process a user message and return the group's responses.
+     * This endpoint accepts a message from a user and processes it through agents in the group based on the specified pattern.
+     * It will stream the steps of the response always, and stream the tokens if 'stream_tokens' is set to True.
+     *
+     * @param {string} groupId
+     * @param {Letta.LettaStreamingRequest} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Letta.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.groups.sendGroupMessageStreaming("group_id", {
+     *         messages: [{
+     *                 role: "user",
+     *                 content: "content"
+     *             }]
+     *     })
+     */
+    sendGroupMessageStreaming(groupId: string, request: Letta.LettaStreamingRequest, requestOptions?: Groups.RequestOptions): Promise<unknown>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string;
+    }>;
+}