mavenagi 1.0.15 → 1.2.0

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

@@ -15,6 +15,8 @@ export declare namespace Conversation {
         organizationId: core.Supplier<string>;
         /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -29,7 +31,7 @@ export declare namespace Conversation {
         /** Override the X-Agent-Id header */
         agentId?: string;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class Conversation {
@@ -58,27 +60,49 @@ export declare class Conversation {
      *             referenceId: "referenceId"
      *         },
      *         messages: [{
+     *                 conversationMessageId: {
+     *                     referenceId: "referenceId"
+     *                 },
      *                 userId: {
      *                     referenceId: "referenceId"
      *                 },
      *                 text: "text",
-     *                 userMessageType: "USER",
+     *                 userMessageType: "USER"
+     *             }, {
      *                 conversationMessageId: {
      *                     referenceId: "referenceId"
-     *                 }
-     *             }, {
+     *                 },
      *                 userId: {
      *                     referenceId: "referenceId"
      *                 },
      *                 text: "text",
-     *                 userMessageType: "USER",
-     *                 conversationMessageId: {
-     *                     referenceId: "referenceId"
-     *                 }
+     *                 userMessageType: "USER"
      *             }]
      *     })
      */
-    initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __initialize;
+    /**
+     * Update mutable conversation fields.
+     *
+     * The `appId` field can be provided to update a conversation owned by a different app.
+     * All other fields will overwrite the existing value on the conversation only if provided.
+     *
+     * @param {string} conversationId - The ID of the conversation to patch
+     * @param {MavenAGI.ConversationPatchRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.patch("conversation-0", {
+     *         llmEnabled: true
+     *     })
+     */
+    patch(conversationId: string, request: MavenAGI.ConversationPatchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __patch;
     /**
      * Get a conversation
      *
@@ -93,7 +117,8 @@ export declare class Conversation {
      * @example
      *     await client.conversation.get("conversationId")
      */
-    get(conversationId: string, request?: MavenAGI.ConversationGetRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    get(conversationId: string, request?: MavenAGI.ConversationGetRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __get;
     /**
      * Wipes a conversation of all user data.
      * The conversation ID will still exist and non-user specific data will still be retained.
@@ -116,7 +141,8 @@ export declare class Conversation {
      *         reason: "GDPR deletion request 1234."
      *     })
      */
-    delete(conversationId: string, request: MavenAGI.ConversationDeleteRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    delete(conversationId: string, request: MavenAGI.ConversationDeleteRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     /**
      * 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. Messages do not allow modification.
      *
@@ -130,26 +156,27 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.appendNewMessages("conversationId", [{
+     *             conversationMessageId: {
+     *                 referenceId: "referenceId"
+     *             },
      *             userId: {
      *                 referenceId: "referenceId"
      *             },
      *             text: "text",
-     *             userMessageType: "USER",
+     *             userMessageType: "USER"
+     *         }, {
      *             conversationMessageId: {
      *                 referenceId: "referenceId"
-     *             }
-     *         }, {
+     *             },
      *             userId: {
      *                 referenceId: "referenceId"
      *             },
      *             text: "text",
-     *             userMessageType: "USER",
-     *             conversationMessageId: {
-     *                 referenceId: "referenceId"
-     *             }
+     *             userMessageType: "USER"
      *         }])
      */
-    appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __appendNewMessages;
     /**
      * Get an answer from Maven for a given user question. If the user question or its answer already exists,
      * they will be reused and will not be updated. Messages do not allow modification once generated.
@@ -189,7 +216,8 @@ export declare class Conversation {
      *         timezone: "America/New_York"
      *     })
      */
-    ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __ask;
     /**
      * Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
      * The text portions of stream responses should be concatenated to form the full response text.
@@ -205,7 +233,8 @@ export declare class Conversation {
      * Known Limitation:
      * - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
      */
-    askStream(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<core.Stream<MavenAGI.StreamResponse>>;
+    askStream(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<core.Stream<MavenAGI.StreamResponse>>;
+    private __askStream;
     /**
      * This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
      *
@@ -226,37 +255,25 @@ export declare class Conversation {
      *             }]
      *     })
      */
-    generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __generateMavenSuggestions;
     /**
-     * Generate a structured object response based on a provided schema and user prompt.
+     * Generate a structured object response based on a provided schema and user prompt with a streaming response.
+     * The response will be sent as a stream of events containing text, start, and end events.
+     * The text portions of stream responses should be concatenated to form the full response text.
      *
      * If the user question and object response already exist, they will be reused and not updated.
      *
+     * Concurrency Behavior:
+     * - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
+     * - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
+     *
      * Known Limitations:
      * - Schema enforcement is best-effort and may not guarantee exact conformity.
-     * - This endpoint does not stream results. Use `askDataStream` (coming soon) for progressive rendering.
-     *
-     * @param {string} conversationId - The ID of a new or existing conversation to use as context for the object generation request
-     * @param {MavenAGI.GenerateObjectRequest} request
-     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link MavenAGI.NotFoundError}
-     * @throws {@link MavenAGI.BadRequestError}
-     * @throws {@link MavenAGI.ServerError}
-     *
-     * @example
-     *     await client.conversation.generateObject("conversationId", {
-     *         conversationMessageId: {
-     *             referenceId: "referenceId"
-     *         },
-     *         userId: {
-     *             referenceId: "referenceId"
-     *         },
-     *         text: "text",
-     *         schema: "schema"
-     *     })
+     * - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
      */
-    generateObject(conversationId: string, request: MavenAGI.GenerateObjectRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.BotObjectResponse>;
+    askObjectStream(conversationId: string, request: MavenAGI.AskObjectRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<core.Stream<MavenAGI.ObjectStreamResponse>>;
+    private __askObjectStream;
     /**
      * Uses an LLM flow to categorize the conversation. Experimental.
      *
@@ -270,7 +287,8 @@ export declare class Conversation {
      * @example
      *     await client.conversation.categorize("conversationId")
      */
-    categorize(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.CategorizationResponse>;
+    categorize(conversationId: string, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.CategorizationResponse>;
+    private __categorize;
     /**
      * Update feedback or create it if it doesn't exist
      *
@@ -299,7 +317,8 @@ export declare class Conversation {
      *         text: "Great answer!"
      *     })
      */
-    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.Feedback>;
+    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.Feedback>;
+    private __createFeedback;
     /**
      * Submit a filled out action form
      *
@@ -321,7 +340,8 @@ export declare class Conversation {
      *         }
      *     })
      */
-    submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __submitActionForm;
     /**
      * Replaced by `updateConversationMetadata`.
      *
@@ -340,7 +360,8 @@ export declare class Conversation {
      *         "string": "string"
      *     })
      */
-    addConversationMetadata(conversationId: string, request: Record<string, string>, requestOptions?: Conversation.RequestOptions): Promise<Record<string, string>>;
+    addConversationMetadata(conversationId: string, request: Record<string, string>, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<Record<string, string>>;
+    private __addConversationMetadata;
     /**
      * Update metadata supplied by the calling application for an existing conversation.
      * Does not modify metadata saved by other apps.
@@ -366,7 +387,8 @@ export declare class Conversation {
      *         }
      *     })
      */
-    updateConversationMetadata(conversationId: string, request: MavenAGI.UpdateMetadataRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationMetadata>;
+    updateConversationMetadata(conversationId: string, request: MavenAGI.UpdateMetadataRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationMetadata>;
+    private __updateConversationMetadata;
     /**
      * Search conversations
      *
@@ -380,6 +402,44 @@ export declare class Conversation {
      * @example
      *     await client.conversation.search({})
      */
-    search(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationsResponse>;
+    search(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationsResponse>;
+    private __search;
+    /**
+     * Deliver a message to a user or conversation.
+     *
+     * <Warning>
+     * Currently, messages can only be successfully delivered to conversations with the `ASYNC` capability that are `open`.
+     * User message delivery is not yet supported.
+     * </Warning>
+     *
+     * @param {MavenAGI.DeliverMessageRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.deliverMessage({
+     *         type: "user",
+     *         userId: {
+     *             type: "AGENT",
+     *             appId: "appId",
+     *             referenceId: "referenceId"
+     *         },
+     *         message: {
+     *             conversationMessageId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             userId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             text: "text",
+     *             userMessageType: "USER"
+     *         }
+     *     })
+     */
+    deliverMessage(request: MavenAGI.DeliverMessageRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.DeliverMessageResponse>;
+    private __deliverMessage;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }