@wix/auto_sdk_forms_interactive-form-sessions 1.0.3 → 1.0.5

package/build/es/index.typings.d.mts

@@ -1,445 +1,530 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
+/**
+ * An interactive form session enables AI-powered conversational form completion.
+ * The session maintains conversation context and tracks form data extraction throughout
+ * the user's interaction with the AI assistant.
+ */
 interface InteractiveFormSession {
     /**
-     * Form completion id
+     * Interactive form session ID.
      * @format GUID
      * @readonly
      */
     _id?: string;
     /**
-     * Form id to complete
+     * Form ID.
      * @format GUID
      */
     formId?: string;
 }
 interface CreateInteractiveFormSessionRequest {
     /**
-     * Interactive form session to be created.
+     * Form ID to create an interactive session for.
      * @format GUID
      */
     formId: string;
     /**
-     * ID of the prompt to use.
+     * Custom prompt ID to use for the AI assistant's conversation style and behavior.
+     * When not provided, uses the form's default chat settings configured in the Chat Settings API.
      * @format GUID
      */
     promptId?: string | null;
     /**
-     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
-     * These values are merged with existing values in the session.
-     * For example, if user has already filled field "Name" and then sends a message with current_values containing
-     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
-     * it will override the existing value.
+     * Pre-filled values to apply to the form, to initialize the session with existing data.
+     * Field keys must match the form schema field names.
+     * For example: `{"firstName": "John", "email": "john@example.com", "age": 25}`.
+     * These values are merged with any data extracted during the conversation.
      */
     currentValues?: Record<string, any> | null;
     /**
-     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * Whether the session should run in dry run mode for testing and preview purposes.
+     * In dry run mode, the full conversational flow works normally and form data is extracted,
+     * but no actual form submission occurs.
      * @immutable
      */
     dryRun?: boolean;
     /**
-     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * Deprecated, use `clientTime` instead.
      * @minLength 1
      * @maxLength 200
      */
     currentTime?: string | null;
-    /** Current date-time of api client */
+    /** Current date-time of api client. */
     clientTime?: ClientTime;
 }
 interface ClientTime {
     /**
-     * Current date-time string UTC in ISO 8601 format (e.g. "2023-10-01T12:00:00Z).
+     * Current date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
+     * For example, `2023-10-01T12:00:00Z`.
      * @minLength 1
      * @maxLength 200
      */
     currentTime?: string | null;
     /**
-     * Current time zone in format like: "Europe/Vilnius".
+     * Caller's timezone identifier for localizing date and time values in IANA timezone format (for example, `Europe/Vilnius`, `America/New_York`).
      * @minLength 1
      * @maxLength 50
      */
     timeZone?: string | null;
 }
 interface CreateInteractiveFormSessionResponse {
-    /** Interactive form session created */
+    /** Created interactive form session. */
     interactiveFormSession?: InteractiveFormSession;
-    /** Assistant response chunks for the session */
+    /** AI assistant response chunks for the interactive form session. */
     responseChunks?: InteractiveFormSessionResponseChunk[];
 }
+/**
+ * AI assistant response chunk, containing different types of conversational content.
+ * Chunks are delivered sequentially and must be processed in order to build the complete
+ * conversation interface. Each chunk type requires different UI handling.
+ */
 interface InteractiveFormSessionResponseChunk extends InteractiveFormSessionResponseChunkOfOneOf {
-    /** Text chunk to display to the user */
+    /** Conversational text message for display to the user. */
     textDetails?: TextDetails;
-    /** Data chunk which was extracted from the user input */
+    /** Structured data extracted from user input and mapped to specific form fields. */
     textDataDetails?: TextDataDetails;
-    /** Multi-select input chunk to display to the user */
+    /** Selector for selecting multiple options from a predefined list. */
     multiSelectInputDetails?: MultiSelectInputDetails;
-    /** Number input chunk to display to the user */
+    /** Selector for numeric input with optional range and validation constraints. */
     numberInputDetails?: NumberInputDetails;
-    /** Separator chunk (e.g. paragraph break) */
+    /** Visual separator element for organizing conversation flow. */
     separatorDetails?: SeparatorDetails;
-    /** Single-select input chunk to display to the user */
+    /** Selector for selecting a single option from a predefined list. */
     singleSelectInputDetails?: SingleSelectInputDetails;
-    /** Exception happened during processing, contains error message and details */
+    /** Error information when processing fails or validation errors occur. */
     errorDetails?: ErrorDetails;
-    /** Form submission event acknowledgment chunk, contains submission id and checkout id if applicable */
+    /** Form submission confirmation containing form submission ID and ecom checkout ID, if relevant. */
     submissionDetails?: SubmissionDetails;
-    /** Important information which might be used to derive TEXT_DATA */
+    /** Important contextual information that may influence data extraction or user decisions. */
     importantTextDetails?: ImportantTextDetails;
-    /** Debug information, what tools were called, what was the input, etc. */
+    /** Diagnostic information for development, debugging, and performance monitoring. */
     debugDetails?: DebugDetails;
-    /** End of chunk stream, indicates that no more chunks will be sent */
+    /** Stream completion signal indicating no more chunks will be sent in this response. */
     endOfResponseDetails?: EndOfResponseDetails;
-    /** Multi-select input chunk to display to the user */
+    /** Input for file upload with field targeting. Not supported. */
     fileUploadDetails?: FileUploadDetails;
-    /** Multi-select input chunk to display to the user */
+    /** Input for digital signature capture with field targeting. Not supported. */
     signatureDetails?: SignatureDetails;
-    /** Type of the chunk */
+    /** Response chunk type, that determines how the content should be processed and displayed. */
     chunkType?: ChunkTypeWithLiterals;
-    /** Marks which part of the original user input deemed meaningful by the assistant for extracting the answer. */
+    /**
+     * Indicates which portion of the original user input was meaningful for data extraction.
+     * Can be used to highlight relevant parts of the user's message in the UI.
+     */
     meaningfulInput?: MeaningfulInput;
 }
 /** @oneof */
 interface InteractiveFormSessionResponseChunkOfOneOf {
-    /** Text chunk to display to the user */
+    /** Conversational text message for display to the user. */
     textDetails?: TextDetails;
-    /** Data chunk which was extracted from the user input */
+    /** Structured data extracted from user input and mapped to specific form fields. */
     textDataDetails?: TextDataDetails;
-    /** Multi-select input chunk to display to the user */
+    /** Selector for selecting multiple options from a predefined list. */
     multiSelectInputDetails?: MultiSelectInputDetails;
-    /** Number input chunk to display to the user */
+    /** Selector for numeric input with optional range and validation constraints. */
     numberInputDetails?: NumberInputDetails;
-    /** Separator chunk (e.g. paragraph break) */
+    /** Visual separator element for organizing conversation flow. */
     separatorDetails?: SeparatorDetails;
-    /** Single-select input chunk to display to the user */
+    /** Selector for selecting a single option from a predefined list. */
     singleSelectInputDetails?: SingleSelectInputDetails;
-    /** Exception happened during processing, contains error message and details */
+    /** Error information when processing fails or validation errors occur. */
     errorDetails?: ErrorDetails;
-    /** Form submission event acknowledgment chunk, contains submission id and checkout id if applicable */
+    /** Form submission confirmation containing form submission ID and ecom checkout ID, if relevant. */
     submissionDetails?: SubmissionDetails;
-    /** Important information which might be used to derive TEXT_DATA */
+    /** Important contextual information that may influence data extraction or user decisions. */
     importantTextDetails?: ImportantTextDetails;
-    /** Debug information, what tools were called, what was the input, etc. */
+    /** Diagnostic information for development, debugging, and performance monitoring. */
     debugDetails?: DebugDetails;
-    /** End of chunk stream, indicates that no more chunks will be sent */
+    /** Stream completion signal indicating no more chunks will be sent in this response. */
     endOfResponseDetails?: EndOfResponseDetails;
-    /** Multi-select input chunk to display to the user */
+    /** Input for file upload with field targeting. Not supported. */
     fileUploadDetails?: FileUploadDetails;
-    /** Multi-select input chunk to display to the user */
+    /** Input for digital signature capture with field targeting. Not supported. */
     signatureDetails?: SignatureDetails;
 }
 declare enum ChunkType {
+    /** Unknown chunk type. */
     UNKNOWN_CHUNK_TYPE = "UNKNOWN_CHUNK_TYPE",
-    /** Text chunk to display to the user */
+    /** Text message for display to the user. */
     TEXT = "TEXT",
-    /** Data chunk which was extracted from the user input */
+    /** Structured data extracted from user input and mapped to form fields. */
     TEXT_DATA = "TEXT_DATA",
-    /** Multi-select input chunk to display to the user */
+    /** Selector for selecting multiple options from a list. */
     MULTI_SELECT_INPUT = "MULTI_SELECT_INPUT",
-    /** Number input chunk to display to the user */
+    /** Selector for numeric input with optional validation. */
     NUMBER_INPUT = "NUMBER_INPUT",
+    /** Visual separator element such as paragraph breaks. */
     SEPARATOR = "SEPARATOR",
-    /** Single-select input chunk to display to the user */
+    /** Selector for selecting one option from a list. */
     SINGLE_SELECT_INPUT = "SINGLE_SELECT_INPUT",
-    /** Exception happened during processing, contains error message and details */
+    /** Error message when processing fails or validation errors occur. */
     ERROR = "ERROR",
-    /** Form submission event acknowledgment chunk, contains submission id and checkout id if applicable */
+    /** Form submission confirmation with submission ID and checkout ID, if relevant. */
     SUBMISSION = "SUBMISSION",
-    /** Important information which might be used to derive TEXT_DATA */
+    /** Highlighted information that may influence form data extraction. */
     IMPORTANT_TEXT = "IMPORTANT_TEXT",
-    /** Debug information, what tools were called, what was the input, etc. */
+    /** Diagnostic information for troubleshooting and development. */
     DEBUG = "DEBUG",
-    /** End of chunk stream, indicates that no more chunks will be sent */
+    /** Signals the completion of a response stream. */
     END_OF_RESPONSE = "END_OF_RESPONSE",
-    /** File Upload input chunk to display to the user */
+    /** Input for file upload. Not supported. */
     FILE_UPLOAD = "FILE_UPLOAD",
-    /** Signature input chunk to display to the user */
+    /** Input for digital signature capture. Not supported. */
     SIGNATURE = "SIGNATURE"
 }
 /** @enumType */
 type ChunkTypeWithLiterals = ChunkType | 'UNKNOWN_CHUNK_TYPE' | 'TEXT' | 'TEXT_DATA' | 'MULTI_SELECT_INPUT' | 'NUMBER_INPUT' | 'SEPARATOR' | 'SINGLE_SELECT_INPUT' | 'ERROR' | 'SUBMISSION' | 'IMPORTANT_TEXT' | 'DEBUG' | 'END_OF_RESPONSE' | 'FILE_UPLOAD' | 'SIGNATURE';
+/** Conversational text content from the AI assistant. */
 interface TextDetails {
     /**
-     * Text content to display
+     * Text content to display to the user.
      * @minLength 1
      * @maxLength 10000
      */
     text?: string;
-    /** Style of the text (e.g. normal, bold) */
+    /** Text formatting style for visual presentation. */
     style?: StyleWithLiterals;
 }
 declare enum Style {
+    /** Unknown text style. */
     UNKNOWN_STYLE = "UNKNOWN_STYLE",
+    /** Regular conversational text. */
     NORMAL = "NORMAL",
+    /** Bold text for emphasis. */
     BOLD = "BOLD"
 }
 /** @enumType */
 type StyleWithLiterals = Style | 'UNKNOWN_STYLE' | 'NORMAL' | 'BOLD';
+/** Structured data extracted from user input and mapped to form fields. */
 interface TextDataDetails {
     /**
-     * Target field key for the data
+     * Form field identifier that this extracted data maps to.
+     * Matches a field name in the form schema.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
     /**
-     * Text content to display
+     * Human-readable text representation of the extracted data to display to the user.
      * @minLength 1
      * @maxLength 10000
      */
     text?: string;
-    /** "Technical" value used for the form submission, e.g. if it's boolean, value will be `true` or `false` */
+    /**
+     * Structured value for form submission (for example, boolean `true`/`false`, number, or string).
+     * This is the actual data value that will be submitted with the form.
+     */
     value?: any;
     /**
-     * User friendly string to display user's submitted value, e.g. if it's boolean, value will be "Yes" or "No"
+     * User-friendly display representation of the value (for example, "Yes"/"No" for boolean, "25 years old" for age).
+     * Use this to display confirmation of what was extracted from the user's input.
      * @minLength 1
      * @maxLength 10000
      */
     displayValue?: string;
 }
+/** Interactive prompt for selecting multiple options from a predefined list. */
 interface MultiSelectInputDetails {
     /**
-     * Field id for the multi-select input
+     * Form field identifier for the multi-select input.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
     /**
-     * Options available for selection
+     * Options available for selection, when relevant. Users can choose multiple options from this list.
      * @minSize 1
      * @maxSize 100
      */
     options?: Option[];
-    /** If present, then user is allowed to provide custom values */
+    /** When present, allows users to provide custom values not in the predefined options list. */
     allowedCustomValue?: CustomValue;
 }
+/** Selection option for input prompts. */
 interface Option {
     /**
-     * Value to be submitted for the option
+     * Value to be submitted when this option is selected.
+     * This is the technical value used in form processing and submission.
      * @minLength 1
      * @maxLength 10000
      */
     value?: string;
     /**
-     * Label to display for the option
+     * Human-readable label displayed to the user for this option.
      * @minLength 1
      * @maxLength 10000
      */
     label?: string;
 }
+/** Custom value configuration for input prompts. */
 interface CustomValue {
     /**
-     * Description of expected custom value
+     * Description of the expected custom value format or content.
+     * Displayed to guide users when they choose to provide a custom option.
      * @maxLength 10000
      */
     description?: string;
 }
+/** Interactive prompt for numeric input with validation constraints. */
 interface NumberInputDetails {
     /**
-     * Field id for the number input
+     * Form field identifier for the numeric input.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
-    /** Limit min and max range for the input */
+    /** Minimum and maximum value constraints for the numeric input. */
     rangeLimit?: NumberRangeLimit;
-    /** If provided, only multiples of this value are accepted */
+    /**
+     * When provided, restricts input to multiples of this value.
+     * For example, `2.5` would allow 2.5, 5.0, 7.5, and so on.
+     */
     multipleOf?: number | null;
 }
+/** Numeric range constraints for number input validation. */
 interface NumberRangeLimit extends NumberRangeLimitEndOneOf {
-    /** Maximum value of the range (inclusive) */
+    /** Maximum allowed value (inclusive). */
     maxInclusiveValue?: number | null;
-    /** Maximum value of the range (exclusive) */
+    /** Maximum allowed value (exclusive). */
     maxExclusiveValue?: number | null;
-    /** Minimum value of the range (inclusive) */
+    /** Minimum allowed value (inclusive). */
     minInclusiveValue?: number | null;
 }
 /** @oneof */
 interface NumberRangeLimitEndOneOf {
-    /** Maximum value of the range (inclusive) */
+    /** Maximum allowed value (inclusive). */
     maxInclusiveValue?: number | null;
-    /** Maximum value of the range (exclusive) */
+    /** Maximum allowed value (exclusive). */
     maxExclusiveValue?: number | null;
 }
+/** Visual separator element for organizing conversation flow. */
 interface SeparatorDetails {
-    /** Type of separator (e.g. paragraph) */
+    /** Type of visual separator to display in the conversation flow. */
     type?: TypeWithLiterals;
 }
 declare enum Type {
+    /** Unknown separator type. */
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Paragraph break for visual content separation. */
     PARAGRAPH = "PARAGRAPH"
 }
 /** @enumType */
 type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'PARAGRAPH';
+/** Selector for selecting a single option from a predefined list. */
 interface SingleSelectInputDetails {
     /**
-     * Field id for the single-select input
+     * Form field identifier for the single-select input.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
     /**
-     * Options available for selection
+     * Options available for selection. Users can choose only one option from this list.
      * @minSize 1
      * @maxSize 100
      */
     options?: Option[];
-    /** If present, then user is allowed to provide custom values */
+    /** When present, allows users to provide a custom value not in the predefined options list. */
     allowedCustomValue?: CustomValue;
 }
+/** Error information when processing fails or validation errors occur. */
 interface ErrorDetails {
     /**
-     * Error message text
+     * Error message detailing what went wrong during processing.
+     * For display to the user when the AI cannot process their input or when validation fails.
      * @minLength 1
      * @maxLength 1000
      */
     messageText?: string;
 }
+/** Form submission confirmation containing submission and checkout information. */
 interface SubmissionDetails {
     /**
-     * Created submission id
+     * Form submission ID created when the form is successfully completed and submitted.
      * @format GUID
      */
     submissionId?: string;
     /**
-     * ID of the ecom checkout related to submission (only applicable if a form has payments).
+     * Wix eCommerce checkout ID when the form includes payment processing.
+     * Only present for forms that have payment fields or are connected to eCommerce flows.
      * @format GUID
      * @readonly
      */
     checkoutId?: string | null;
 }
+/** Important contextual information that may influence data extraction or user decisions. */
 interface ImportantTextDetails {
     /**
-     * Target field key for the important text
+     * Form field identifier that this important information relates to.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
     /**
-     * Important text content to display
+     * Important contextual information to highlight for the user.
+     * This might include validation requirements, format expectations, or clarifying questions.
      * @minLength 1
      * @maxLength 10000
      */
     text?: string;
 }
+/** Diagnostic information for development and troubleshooting. */
 interface DebugDetails {
-    /** Debug data for troubleshooting */
+    /**
+     * Diagnostic data for development and troubleshooting.
+     * Contains information such as AI tools called, processing times, and internal state.
+     */
     data?: Record<string, any> | null;
 }
+/** Stream completion signal indicating the end of a response stream. */
 interface EndOfResponseDetails {
-    /** If the response was successful */
+    /**
+     * Whether the response stream completed successfully.
+     * When `false`, there may have been processing errors or interruptions.
+     */
     success?: boolean;
 }
+/** Interactive prompt for file upload input. */
 interface FileUploadDetails {
     /**
-     * Field id for the file upload input
+     * Form field identifier for the file upload input.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
 }
+/** Interactive prompt for digital signature capture. */
 interface SignatureDetails {
     /**
-     * Field id for the signature input
+     * Form field identifier for the digital signature input.
      * @minLength 1
      * @maxLength 200
      */
     fieldTarget?: string;
 }
+/** Indicates which portion of user input was meaningful for data extraction. */
 interface MeaningfulInput {
     /**
-     * Character offset (0-indexed) from the start of the user input to where the meaningful text starts
+     * Character position (0-indexed) where the meaningful portion of user input begins.
      * @max 10000
      */
     startOffset?: number;
     /**
-     * Length of the meaningful text in characters
+     * Length in characters of the meaningful portion of user input.
+     * Use this with `startOffset` to highlight the relevant text that was processed for data extraction.
      * @max 10000
      */
     length?: number;
 }
 interface CreateInteractiveFormSessionStreamedRequest {
     /**
-     * Interactive form session to be created.
+     * Form ID to create an interactive session for.
      * @format GUID
      */
     formId: string;
     /**
-     * ID of the prompt to use.
+     * Custom prompt ID to use for the AI assistant's conversation style and behavior.
+     * When not provided, uses the form's default chat settings configured in the Chat Settings API.
      * @format GUID
      */
     promptId?: string | null;
-    /** Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form). */
+    /**
+     * Pre-filled values to apply to the form, to initialize the session with existing data.
+     * Field keys must match the form schema field names.
+     * For example: `{"firstName": "John", "email": "john@example.com", "age": 25}`.
+     * These values are merged with any data extracted during the conversation.
+     */
     currentValues?: Record<string, any> | null;
     /**
-     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * Whether the session should run in dry run mode when no actual form submission occurs.
+     * In dry run mode, the full conversational flow works normally and form data is extracted,
+     * but no actual form submission occurs.
+     *
+     * Default: `false`
      * @immutable
      */
     dryRun?: boolean;
     /**
-     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * Current date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
+     * For example, `2023-10-01T12:00:00Z`.
+     * If not provided, server time is used.
      * @minLength 1
      * @maxLength 200
      */
     currentTime?: string | null;
-    /** Current date-time of api client */
+    /** Caller's local date and time. */
     clientTime?: ClientTime;
 }
 interface CreateInteractiveFormSessionStreamedResponse {
-    /** Assistant response chunk */
+    /**
+     * AI assistant response chunk, streamed in real-time.
+     * Process each chunk as it arrives to provide progressive user feedback.
+     */
     responseChunk?: InteractiveFormSessionResponseChunk;
-    /** Interactive form session. Only returned on the 1st chunk of the stream. */
+    /**
+     * Information about the created interactive form session.
+     * Only included in the first chunk of the stream to provide session details immediately.
+     */
     interactiveFormSession?: InteractiveFormSession;
 }
 interface SendUserMessageRequest {
     /**
-     * Interactive form session id
+     * Interactive form session ID to send the message to.
      * @format GUID
      */
     interactiveFormSessionId: string;
     /**
-     * User input to add to the session
+     * User's natural language input.
+     * The AI assistant analyzes this text to extract form field data and determine the next conversation step.
+     * Maximum length: 10,000 characters.
      * @maxLength 10000
      */
     input?: string | null;
     /**
-     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
-     * These values are merged with existing values in the session.
-     * For example, if user has already filled field "Name" and then sends a message with current_values containing
-     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
-     * it will override the existing value.
+     * Form field values to apply to the session.
+     * Use this to update form data from other sources while the conversation is ongoing.
+     * These values override any existing data for the same field keys.
+     * For example: `{"lastName": "Smith", "phoneNumber": "+1234567890"}`.
      */
     currentValues?: Record<string, any> | null;
 }
 interface SendUserMessageResponse {
-    /** Interactive form session after input is added */
+    /** Updated interactive form session after the user input is processed. */
     interactiveFormSession?: InteractiveFormSession;
-    /** Assistant response chunks for the input */
+    /**
+     * AI assistant response chunks generated from processing the user's message.
+     * These can include extracted data, follow-up questions, input prompts, or submission confirmation.
+     */
     responseChunks?: InteractiveFormSessionResponseChunk[];
 }
 interface SendUserMessageStreamedRequest {
     /**
-     * Interactive form session id
+     * Interactive form session ID to send the message to.
      * @format GUID
      */
     interactiveFormSessionId: string;
     /**
-     * User input to add to the session
+     * User's natural language input to process.
+     * The AI assistant analyzes this text to extract form field data and determine the next conversation step.
      * @maxLength 10000
      */
     input?: string | null;
     /**
-     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
-     * These values are merged with existing values in the session.
-     * For example, if user has already filled field "Name" and then sends a message with current_values containing
-     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
-     * it will override the existing value.
+     * Form field values to apply to the session.
+     * Use this to update form data from other sources while the conversation is ongoing.
+     * These values override any existing data for the same field keys.
+     * For example: `{"lastName": "Smith", "phoneNumber": "+1234567890"}`.
      */
     currentValues?: Record<string, any> | null;
 }
 interface SendUserMessageStreamedResponse {
-    /** Assistant response chunk for the streamed input */
+    /** AI assistant response chunk streamed in real-time as the message is processed. */
     responseChunk?: InteractiveFormSessionResponseChunk;
-    /** Interactive form session after input is added */
+    /**
+     * Updated interactive form session information.
+     * Included in response chunks to provide current session state.
+     */
     interactiveFormSession?: InteractiveFormSession;
 }
 interface ConverseRequest extends ConverseRequestRequestOneOf {
@@ -652,11 +737,17 @@ interface ContextMessageOptionsOneOf {
     developerOptions?: DeveloperOptions;
 }
 declare enum Role {
+    /** Unknown message role. */
     UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Message from the user. */
     USER = "USER",
+    /** Message from the AI assistant. */
     ASSISTANT = "ASSISTANT",
+    /** Function call message. */
     FUNCTION_CALL = "FUNCTION_CALL",
+    /** Function call output message. */
     FUNCTION_CALL_OUTPUT = "FUNCTION_CALL_OUTPUT",
+    /** Message from the developer/system. */
     DEVELOPER = "DEVELOPER"
 }
 /** @enumType */
@@ -729,7 +820,7 @@ interface Response {
     response?: Record<string, any> | null;
 }
 interface AcknowledgmentResponse {
-    /** If request processing is successful */
+    /** Whether request processing was successful. */
     success?: boolean;
 }
 interface OutputInteractiveFormSessionStreamedRequest {
@@ -745,14 +836,15 @@ interface OutputInteractiveFormSessionStreamedResponse {
     /** Assistant response chunk for the session */
     responseChunk?: InteractiveFormSessionResponseChunk;
 }
+/** Request to report a conversation for quality assurance. */
 interface ReportConversationRequest {
     /**
-     * Interactive form session id
+     * Interactive form session ID to report.
      * @format GUID
      */
     interactiveFormSessionId?: string;
     /**
-     * Report description
+     * Details about the issue or feedback.
      * @minLength 1
      * @maxLength 10000
      */
@@ -763,15 +855,28 @@ interface ReportConversationRequest {
      */
     viewerDebugUrl?: string;
 }
+/** Response confirming conversation report submission. */
 interface ReportConversationResponse {
-    /** If the report was successfully created */
+    /** Whether the report was successfully created. */
     success?: boolean | null;
     /**
-     * Error message if the report creation failed
+     * Error message.
      * @maxLength 10000
      */
     errorMessage?: string | null;
 }
+/** TEMPORARY: Request message for test error endpoints */
+interface TestErrorRegularRequest {
+}
+/** TEMPORARY: Response message for regular test error endpoint */
+interface TestErrorRegularResponse {
+}
+/** TEMPORARY: Request message for test error endpoints */
+interface TestErrorStreamingRequest {
+}
+/** TEMPORARY: Response message for streaming test error endpoint */
+interface TestErrorStreamingResponse {
+}
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -919,48 +1024,54 @@ type SendUserMessageStreamedApplicationErrors = {
     data?: Record<string, any>;
 };
 /**
- * Starts interactive form session for a given form
- * @param formId - Interactive form session to be created.
+ * Creates an interactive form session for AI-powered conversational form completion.
+ *
+ * For implementations that require real-time streaming, call [Create Interactive Form Session Streamed](https://dev.wix.com/docs/api-reference/crm/forms/interactive-form-session/create-interactive-form-session-streamed) instead.
+ * @param formId - Form ID to create an interactive session for.
  * @public
  * @documentationMaturity preview
  * @requiredField formId
  * @permissionId WIX_FORMS.CREATE_INTERACTIVE_FORM_SESSION
  * @applicableIdentity APP
- * @returns Interactive form session created
+ * @returns Created interactive form session.
  * @fqn wix.forms.ai.v1.InteractiveFormSessionsService.CreateInteractiveFormSession
  */
 declare function createInteractiveFormSession(formId: string, options?: CreateInteractiveFormSessionOptions): Promise<NonNullablePaths<InteractiveFormSession, `_id` | `formId`, 2>>;
 interface CreateInteractiveFormSessionOptions {
     /**
-     * ID of the prompt to use.
+     * Custom prompt ID to use for the AI assistant's conversation style and behavior.
+     * When not provided, uses the form's default chat settings configured in the Chat Settings API.
      * @format GUID
      */
     promptId?: string | null;
     /**
-     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
-     * These values are merged with existing values in the session.
-     * For example, if user has already filled field "Name" and then sends a message with current_values containing
-     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
-     * it will override the existing value.
+     * Pre-filled values to apply to the form, to initialize the session with existing data.
+     * Field keys must match the form schema field names.
+     * For example: `{"firstName": "John", "email": "john@example.com", "age": 25}`.
+     * These values are merged with any data extracted during the conversation.
      */
     currentValues?: Record<string, any> | null;
     /**
-     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * Whether the session should run in dry run mode for testing and preview purposes.
+     * In dry run mode, the full conversational flow works normally and form data is extracted,
+     * but no actual form submission occurs.
      * @immutable
      */
     dryRun?: boolean;
     /**
-     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * Deprecated, use `clientTime` instead.
      * @minLength 1
      * @maxLength 200
      */
     currentTime?: string | null;
-    /** Current date-time of api client */
+    /** Current date-time of api client. */
     clientTime?: ClientTime;
 }
 /**
- * Starts interactive form session for a given form with streamed response
- * @param formId - Interactive form session to be created.
+ * Creates an interactive form session for AI-powered conversational form completion, with real-time streaming.
+ *
+ * For implementations that prefer to wait for the complete response, call [Create Interactive Form Session](https://dev.wix.com/docs/api-reference/crm/forms/interactive-form-session/create-interactive-form-session) instead.
+ * @param formId - Form ID to create an interactive session for.
  * @public
  * @documentationMaturity preview
  * @requiredField formId
@@ -971,29 +1082,44 @@ interface CreateInteractiveFormSessionOptions {
 declare function createInteractiveFormSessionStreamed(formId: string, options?: CreateInteractiveFormSessionStreamedOptions): Promise<NonNullablePaths<CreateInteractiveFormSessionStreamedResponse, `responseChunk.textDetails.text` | `responseChunk.textDetails.style` | `responseChunk.textDataDetails.fieldTarget` | `responseChunk.textDataDetails.text` | `responseChunk.textDataDetails.displayValue` | `responseChunk.multiSelectInputDetails.fieldTarget` | `responseChunk.multiSelectInputDetails.options` | `responseChunk.multiSelectInputDetails.options.${number}.value` | `responseChunk.multiSelectInputDetails.options.${number}.label` | `responseChunk.multiSelectInputDetails.allowedCustomValue.description` | `responseChunk.numberInputDetails.fieldTarget` | `responseChunk.separatorDetails.type` | `responseChunk.singleSelectInputDetails.fieldTarget` | `responseChunk.singleSelectInputDetails.options` | `responseChunk.errorDetails.messageText` | `responseChunk.submissionDetails.submissionId` | `responseChunk.importantTextDetails.fieldTarget` | `responseChunk.importantTextDetails.text` | `responseChunk.endOfResponseDetails.success` | `responseChunk.fileUploadDetails.fieldTarget` | `responseChunk.signatureDetails.fieldTarget` | `responseChunk.chunkType` | `responseChunk.meaningfulInput.startOffset` | `responseChunk.meaningfulInput.length` | `interactiveFormSession._id` | `interactiveFormSession.formId`, 6>>;
 interface CreateInteractiveFormSessionStreamedOptions {
     /**
-     * ID of the prompt to use.
+     * Custom prompt ID to use for the AI assistant's conversation style and behavior.
+     * When not provided, uses the form's default chat settings configured in the Chat Settings API.
      * @format GUID
      */
     promptId?: string | null;
-    /** Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form). */
+    /**
+     * Pre-filled values to apply to the form, to initialize the session with existing data.
+     * Field keys must match the form schema field names.
+     * For example: `{"firstName": "John", "email": "john@example.com", "age": 25}`.
+     * These values are merged with any data extracted during the conversation.
+     */
     currentValues?: Record<string, any> | null;
     /**
-     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * Whether the session should run in dry run mode when no actual form submission occurs.
+     * In dry run mode, the full conversational flow works normally and form data is extracted,
+     * but no actual form submission occurs.
+     *
+     * Default: `false`
      * @immutable
      */
     dryRun?: boolean;
     /**
-     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * Current date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
+     * For example, `2023-10-01T12:00:00Z`.
+     * If not provided, server time is used.
      * @minLength 1
      * @maxLength 200
      */
     currentTime?: string | null;
-    /** Current date-time of api client */
+    /** Caller's local date and time. */
     clientTime?: ClientTime;
 }
 /**
- * Sends user message to the interactive form session
- * @param interactiveFormSessionId - Interactive form session id
+ * Sends a user message to an existing interactive form session and processes the conversational input.
+ * User messages support up to 10,000 characters.
+ *
+ * For implementations that require real-time streaming, call [Send User Message Streamed](https://dev.wix.com/docs/api-reference/crm/forms/interactive-form-session/send-user-message-streamed) instead.
+ * @param interactiveFormSessionId - Interactive form session ID to send the message to.
  * @public
  * @documentationMaturity preview
  * @requiredField interactiveFormSessionId
@@ -1006,22 +1132,25 @@ declare function sendUserMessage(interactiveFormSessionId: string, options?: Sen
 }>;
 interface SendUserMessageOptions {
     /**
-     * User input to add to the session
+     * User's natural language input.
+     * The AI assistant analyzes this text to extract form field data and determine the next conversation step.
+     * Maximum length: 10,000 characters.
      * @maxLength 10000
      */
     input?: string | null;
     /**
-     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
-     * These values are merged with existing values in the session.
-     * For example, if user has already filled field "Name" and then sends a message with current_values containing
-     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
-     * it will override the existing value.
+     * Form field values to apply to the session.
+     * Use this to update form data from other sources while the conversation is ongoing.
+     * These values override any existing data for the same field keys.
+     * For example: `{"lastName": "Smith", "phoneNumber": "+1234567890"}`.
      */
     currentValues?: Record<string, any> | null;
 }
 /**
- * Sends user message to the interactive form session with streamed response
- * @param interactiveFormSessionId - Interactive form session id
+ * Sends a user message to an existing interactive form session and processes the conversational input, with real-time streaming.
+ *
+ * For implementations that prefer to wait for the complete response, call [Send User Message](https://dev.wix.com/docs/api-reference/crm/forms/interactive-form-session/send-user-message) instead.
+ * @param interactiveFormSessionId - Interactive form session ID to send the message to.
  * @public
  * @documentationMaturity preview
  * @requiredField interactiveFormSessionId
@@ -1034,18 +1163,18 @@ declare function sendUserMessageStreamed(interactiveFormSessionId: string, optio
 }>;
 interface SendUserMessageStreamedOptions {
     /**
-     * User input to add to the session
+     * User's natural language input to process.
+     * The AI assistant analyzes this text to extract form field data and determine the next conversation step.
      * @maxLength 10000
      */
     input?: string | null;
     /**
-     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
-     * These values are merged with existing values in the session.
-     * For example, if user has already filled field "Name" and then sends a message with current_values containing
-     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
-     * it will override the existing value.
+     * Form field values to apply to the session.
+     * Use this to update form data from other sources while the conversation is ongoing.
+     * These values override any existing data for the same field keys.
+     * For example: `{"lastName": "Smith", "phoneNumber": "+1234567890"}`.
      */
     currentValues?: Record<string, any> | null;
 }
 
-export { type AcknowledgmentResponse, type ActionEvent, type AssistantOptions, type Call, type CallToolsRequest, type CallToolsResponse, ChunkType, type ChunkTypeWithLiterals, type ClientTime, type ContextMessage, type ContextMessageOptionsOneOf, type ConverseRequest, type ConverseRequestRequestOneOf, type ConverseResponse, type ConverseResponseResponseOneOf, type CreateInteractiveFormSessionOptions, type CreateInteractiveFormSessionRequest, type CreateInteractiveFormSessionResponse, type CreateInteractiveFormSessionStreamedOptions, type CreateInteractiveFormSessionStreamedRequest, type CreateInteractiveFormSessionStreamedResponse, type CustomValue, type DebugDetails, type DeveloperOptions, type DomainEvent, type DomainEventBodyOneOf, type EndOfResponseDetails, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ErrorDetails, type FileUploadDetails, type FunctionCallOptions, type FunctionCallOutputOptions, type GetStateRequest, type GetStateResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImportantTextDetails, type InteractiveFormSession, type InteractiveFormSessionResponseChunk, type InteractiveFormSessionResponseChunkOfOneOf, type MeaningfulInput, type MessageEnvelope, type MultiSelectInputDetails, type NumberInputDetails, type NumberRangeLimit, type NumberRangeLimitEndOneOf, type Option, type OutputInteractiveFormSessionStreamedRequest, type OutputInteractiveFormSessionStreamedResponse, type RelayAssistantMessageRequest, type ReportConversationRequest, type ReportConversationResponse, type Response, type RestoreInfo, Role, type RoleWithLiterals, type SendUserMessageApplicationErrors, type SendUserMessageOptions, type SendUserMessageRequest, type SendUserMessageResponse, type SendUserMessageStreamedApplicationErrors, type SendUserMessageStreamedOptions, type SendUserMessageStreamedRequest, type SendUserMessageStreamedResponse, type SeparatorDetails, type SignatureDetails, type SingleSelectInputDetails, Style, type StyleWithLiterals, type SubmissionDetails, type TextDataDetails, type TextDetails, type Tool, Type, type TypeWithLiterals, type Usage, type UsageRequest, type UserOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createInteractiveFormSession, createInteractiveFormSessionStreamed, sendUserMessage, sendUserMessageStreamed };
+export { type AcknowledgmentResponse, type ActionEvent, type AssistantOptions, type Call, type CallToolsRequest, type CallToolsResponse, ChunkType, type ChunkTypeWithLiterals, type ClientTime, type ContextMessage, type ContextMessageOptionsOneOf, type ConverseRequest, type ConverseRequestRequestOneOf, type ConverseResponse, type ConverseResponseResponseOneOf, type CreateInteractiveFormSessionOptions, type CreateInteractiveFormSessionRequest, type CreateInteractiveFormSessionResponse, type CreateInteractiveFormSessionStreamedOptions, type CreateInteractiveFormSessionStreamedRequest, type CreateInteractiveFormSessionStreamedResponse, type CustomValue, type DebugDetails, type DeveloperOptions, type DomainEvent, type DomainEventBodyOneOf, type EndOfResponseDetails, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ErrorDetails, type FileUploadDetails, type FunctionCallOptions, type FunctionCallOutputOptions, type GetStateRequest, type GetStateResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImportantTextDetails, type InteractiveFormSession, type InteractiveFormSessionResponseChunk, type InteractiveFormSessionResponseChunkOfOneOf, type MeaningfulInput, type MessageEnvelope, type MultiSelectInputDetails, type NumberInputDetails, type NumberRangeLimit, type NumberRangeLimitEndOneOf, type Option, type OutputInteractiveFormSessionStreamedRequest, type OutputInteractiveFormSessionStreamedResponse, type RelayAssistantMessageRequest, type ReportConversationRequest, type ReportConversationResponse, type Response, type RestoreInfo, Role, type RoleWithLiterals, type SendUserMessageApplicationErrors, type SendUserMessageOptions, type SendUserMessageRequest, type SendUserMessageResponse, type SendUserMessageStreamedApplicationErrors, type SendUserMessageStreamedOptions, type SendUserMessageStreamedRequest, type SendUserMessageStreamedResponse, type SeparatorDetails, type SignatureDetails, type SingleSelectInputDetails, Style, type StyleWithLiterals, type SubmissionDetails, type TestErrorRegularRequest, type TestErrorRegularResponse, type TestErrorStreamingRequest, type TestErrorStreamingResponse, type TextDataDetails, type TextDetails, type Tool, Type, type TypeWithLiterals, type Usage, type UsageRequest, type UserOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createInteractiveFormSession, createInteractiveFormSessionStreamed, sendUserMessage, sendUserMessageStreamed };