mavenagi 0.0.0-alpha.11

package/api/resources/conversation/client/Client.d.ts

@@ -0,0 +1,201 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Conversation {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        organizationId: core.Supplier<string>;
+        agentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Conversation {
+    protected readonly _options: Conversation.Options;
+    constructor(_options: Conversation.Options);
+    /**
+     * Pre-populate a new conversation with messages
+     *
+     * @param {MavenAGI.ConversationRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.initialize({
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
+     *         messages: [{}],
+     *         context: {},
+     *         responseConfig: {
+     *             capabilities: [MavenAGI.Capability.Markdown],
+     *             isCopilot: true,
+     *             responseLength: MavenAGI.ResponseLength.Short
+     *         }
+     *     })
+     */
+    initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Get a conversation
+     *
+     * @param {string} conversationId - The ID of the conversation to get
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.get("string")
+     */
+    get(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Append messages to an existing conversation. The conversation must be initialized first. If a message with the same id already exists, it will be ignored.
+     *
+     * @param {string} conversationId - The ID of the conversation to append messages to
+     * @param {MavenAGI.ConversationMessageRequest[]} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.appendNewMessages("string", [{
+     *             conversationMessageId: {
+     *                 referenceId: "string"
+     *             },
+     *             text: "string",
+     *             userMessageType: MavenAGI.UserConversationMessageType.User,
+     *             context: {}
+     *         }])
+     */
+    appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Ask a question in a conversation
+     *
+     * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
+     * @param {MavenAGI.AskRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.ask("string", {
+     *         conversationMessageId: {
+     *             referenceId: "string"
+     *         },
+     *         text: "string",
+     *         context: {},
+     *         responseConfig: {}
+     *     })
+     */
+    ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Ask a question
+     */
+    askStream(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<core.Stream<MavenAGI.StreamResponse>>;
+    /**
+     * Generate a response suggestion for each requested message id in a conversation
+     *
+     * @param {string} conversationId - The ID of a conversation the messages belong to
+     * @param {MavenAGI.GenerateMavenSuggestionsRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.generateMavenSuggestions("string", {
+     *         conversationMessageIds: [{
+     *                 referenceId: "string"
+     *             }]
+     *     })
+     */
+    generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Create feedback
+     *
+     * @param {MavenAGI.FeedbackRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.createFeedback({
+     *         id: "string",
+     *         conversationId: "string",
+     *         conversationMessageId: "string",
+     *         type: MavenAGI.FeedbackType.ThumbsUp,
+     *         text: "string"
+     *     })
+     */
+    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    /**
+     * Submit a filled out action form
+     *
+     * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
+     * @param {MavenAGI.SubmitActionFormRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.submitActionForm("string", {
+     *         actionFormId: "string",
+     *         userContext: {
+     *             name: "string",
+     *             id: {
+     *                 "string": "string"
+     *             },
+     *             email: "string",
+     *             context: {
+     *                 "string": "string"
+     *             }
+     *         },
+     *         parameters: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
+     */
+    submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
+     *
+     * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
+     * @param {Record<string, string>} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.addConversationMetadata("string", {
+     *         "string": "string"
+     *     })
+     */
+    addConversationMetadata(conversationId: string, request: Record<string, string>, requestOptions?: Conversation.RequestOptions): Promise<Record<string, string>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}