mavenagi 1.2.3 → 1.2.5

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

@@ -1,6 +1,3 @@
-/**
- * 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";
@@ -16,7 +13,7 @@ export declare namespace Conversation {
         /** 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>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -30,8 +27,10 @@ export declare namespace Conversation {
         organizationId?: string;
         /** Override the X-Agent-Id header */
         agentId?: string;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Conversation {
@@ -124,6 +123,9 @@ export declare class Conversation {
      * The conversation ID will still exist and non-user specific data will still be retained.
      * Attempts to modify or add messages to the conversation will throw an error.
      *
+     * Simulation conversations will no longer be visible in search results nor metrics.
+     * Non-simulation conversations will remain visible - they can not be fully removed from the system.
+     *
      * <Warning>This is a destructive operation and cannot be undone. <br/><br/>
      * The exact fields cleared include: the conversation subject, userRequest, agentResponse.
      * As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
@@ -235,28 +237,6 @@ export declare class Conversation {
      */
     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.
-     *
-     * @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("conversationId", {
-     *         conversationMessageIds: [{
-     *                 referenceId: "referenceId"
-     *             }, {
-     *                 referenceId: "referenceId"
-     *             }]
-     *     })
-     */
-    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 with a streaming response.
      * The response will be sent as a stream of events containing text, start, and end events.
@@ -320,7 +300,11 @@ export declare class Conversation {
     createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.Feedback>;
     private __createFeedback;
     /**
-     * Submit a filled out action form
+     * Submit a filled out action form.
+     * Action forms can not be submitted more than once, attempting to do so will result in an error.
+     *
+     * Additionally, form submission is only allowed when the form is the last message in the conversation.
+     * Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
      *
      * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
      * @param {MavenAGI.SubmitActionFormRequest} request
@@ -404,6 +388,19 @@ export declare class Conversation {
      */
     search(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationsResponse>;
     private __search;
+    /**
+     * Export conversations to a CSV file.
+     *
+     * This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
+     *
+     * For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
+     * The CSV format may change over time and should not be relied upon by code consumers.
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    export(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __export;
     /**
      * Deliver a message to a user or conversation.
      *