@airweave/sdk 0.1.28 → 0.1.34

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

@@ -0,0 +1,209 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as AirweaveSDK from "../../../index";
+export declare namespace Chat {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Override the x-api-key header */
+        apiKey?: core.Supplier<string | undefined>;
+    }
+    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;
+        /** Override the x-api-key header */
+        apiKey?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Chat {
+    protected readonly _options: Chat.Options;
+    constructor(_options?: Chat.Options);
+    /**
+     * Check if the OpenAI API key is set for the current user.
+     *
+     * Args:
+     * ----
+     *     db: The database session.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     bool: True if the OpenAI API key is set, False otherwise.
+     *
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.openaiKeySet()
+     */
+    openaiKeySet(requestOptions?: Chat.RequestOptions): Promise<boolean>;
+    /**
+     * List all chats for the current user.
+     *
+     * Args:
+     * ----
+     *     db: The database session.
+     *     skip: The number of chats to skip.
+     *     limit: The number of chats to return.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     list[schemas.Chat]: The list of chats.
+     *
+     * @param {AirweaveSDK.ListChatsChatGetRequest} request
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.listChats()
+     */
+    listChats(request?: AirweaveSDK.ListChatsChatGetRequest, requestOptions?: Chat.RequestOptions): Promise<AirweaveSDK.Chat[]>;
+    /**
+     * Create a new chat.
+     *
+     * Args:
+     * ----
+     *     db: The database session.
+     *     chat_in: The chat creation data.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.Chat: The created chat.
+     *
+     * @param {AirweaveSDK.ChatCreate} request
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.createChat({
+     *         name: "name",
+     *         syncId: "sync_id"
+     *     })
+     */
+    createChat(request: AirweaveSDK.ChatCreate, requestOptions?: Chat.RequestOptions): Promise<AirweaveSDK.Chat>;
+    /**
+     * Get a specific chat by ID.
+     *
+     * Args:
+     * ----
+     *     db: The database session.
+     *     chat_id: The ID of the chat to get.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.Chat: The chat.
+     *
+     * @param {string} chatId
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.getChat("chat_id")
+     */
+    getChat(chatId: string, requestOptions?: Chat.RequestOptions): Promise<AirweaveSDK.Chat>;
+    /**
+     * Update a chat.
+     *
+     * Args:
+     * ----
+     *     db: The database session.
+     *     chat_id: The ID of the chat to update.
+     *     chat_in: The chat update data.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.Chat: The updated chat.
+     *
+     * @param {string} chatId
+     * @param {AirweaveSDK.ChatUpdate} request
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.updateChat("chat_id")
+     */
+    updateChat(chatId: string, request?: AirweaveSDK.ChatUpdate, requestOptions?: Chat.RequestOptions): Promise<AirweaveSDK.Chat>;
+    /**
+     * Archive a chat.
+     *
+     * Args:
+     * ----
+     *     db: The database session.
+     *     chat_id: The ID of the chat to archive.
+     *     user: The current user.
+     *
+     * @param {string} chatId
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.deleteChat("chat_id")
+     */
+    deleteChat(chatId: string, requestOptions?: Chat.RequestOptions): Promise<void>;
+    /**
+     * Send a message to a chat.
+     *
+     * Args:
+     * -----
+     *     db: The database session.
+     *     chat_id: The ID of the chat to send the message to.
+     *     message: The message to send.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.ChatMessage: The sent message.
+     *
+     * @param {string} chatId
+     * @param {AirweaveSDK.ChatMessageCreate} request
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.sendMessage("chat_id", {
+     *         content: "content"
+     *     })
+     */
+    sendMessage(chatId: string, request: AirweaveSDK.ChatMessageCreate, requestOptions?: Chat.RequestOptions): Promise<AirweaveSDK.ChatMessage>;
+    /**
+     * Stream an AI response for a chat message.
+     *
+     * Args:
+     * -----
+     *     db: The database session.
+     *     chat_id: The ID of the chat to stream the response for.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     StreamingResponse: The streaming response.
+     *
+     * @param {string} chatId
+     * @param {Chat.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chat.streamChatResponse("chat_id")
+     */
+    streamChatResponse(chatId: string, requestOptions?: Chat.RequestOptions): Promise<void>;
+}