@epam/ai-dial-chat-shared 1.3.0-dev.6 → 1.3.0-dev.63

package/models/annotation.d.ts

@@ -0,0 +1,143 @@
+/** Selector that targets a character range in a text string. All indices are inclusive. */
+export interface TextCharacterRangeSelector {
+    /** Discriminator — always `'text_character_range'`. */
+    type: 'text_character_range';
+    /** Zero-based start index (inclusive). */
+    start: number;
+    /** Zero-based end index (inclusive). */
+    end: number;
+}
+/** Selector that targets an axis-aligned bounding box on a specific PDF page. */
+export interface PdfBBoxSelector {
+    /** Discriminator — always `'pdf_bbox'`. */
+    type: 'pdf_bbox';
+    /** 1-based PDF page number. */
+    page: number;
+    /** Left edge coordinate. */
+    x1: number;
+    /** Top edge coordinate. */
+    y1: number;
+    /** Right edge coordinate. */
+    x2: number;
+    /** Bottom edge coordinate. */
+    y2: number;
+}
+/** Selector that targets a paired inline tag (e.g. `<cit data-id="…"></cit>`) by its `id` value. */
+export interface HtmlTagSelector {
+    /** Discriminator — always `'html_tag'`. */
+    type: 'html_tag';
+    /** The tag name (e.g. `'cit'`). */
+    tag: string;
+    /** Matches the tag's `data-id` attribute value in the message text, used to associate this selector with its rendered position. */
+    id: string;
+}
+/**
+ * Selector that targets a character range inside a DOCX story. Confirmed
+ * against captured DIAL Core responses: unlike {@link TextCharacterRangeSelector},
+ * `end` is already exclusive on the wire, not inclusive.
+ */
+export interface DocxRangeSelector {
+    /** Discriminator — always `'docx_text_range'`. */
+    type: 'docx_text_range';
+    /** Name of the DOCX story the range lives in, as an opaque string (only `'body'` is confirmed upstream — no closed set). */
+    story: string;
+    /** Source-tree element indices identifying the paragraph, matched element-wise. */
+    path: number[];
+    /** Zero-based start character offset within the story's matched text. */
+    start: number;
+    /** Zero-based end character offset — already exclusive on the wire. */
+    end: number;
+    /** The cited text, expected to equal the text resolved over `[start, end)`. */
+    text: string;
+}
+/**
+ * Selector that targets a character range inside a single shape on one PPTX
+ * slide. Confirmed against captured DIAL Core responses: unlike
+ * {@link TextCharacterRangeSelector}, `end` is already exclusive on the wire.
+ */
+export interface PptxRangeSelector {
+    /** Discriminator — always `'pptx_text_range'`. */
+    type: 'pptx_text_range';
+    /** 1-based slide number. */
+    slide: number;
+    /** Shape identifier, compared as a string against the run's own shape id. */
+    shape_id: string;
+    /** Zero-based start character offset within the shape's matched text. */
+    start: number;
+    /** Zero-based end character offset — already exclusive on the wire. */
+    end: number;
+    /** The cited text, expected to equal the text resolved over `[start, end)`. */
+    text: string;
+}
+/** A 1-based cell address on an XLSX sheet. */
+export interface ExcelCellAddress {
+    /** 1-based row number. */
+    row: number;
+    /** 1-based column number. */
+    col: number;
+}
+/** Selector that targets one cell, or a contiguous same-row cell range, on a named XLSX sheet. */
+export interface ExcelRcRangeSelector {
+    /** Discriminator — always `'excel_rc_range'`. */
+    type: 'excel_rc_range';
+    /** Sheet name, matched exactly against the workbook's own sheet names. */
+    sheet: string;
+    /** First cell of the range. */
+    start: ExcelCellAddress;
+    /** Last (inclusive) cell of the range, on the same row as `start`. `null` and omitted both mean a single cell. */
+    end?: ExcelCellAddress | null;
+}
+/**
+ * Discriminated union of all recognised annotation selector shapes.
+ * Unknown selector types are preserved as an open record to allow forward-compatibility.
+ */
+export type AnnotationSelector = TextCharacterRangeSelector | PdfBBoxSelector | HtmlTagSelector | DocxRangeSelector | PptxRangeSelector | ExcelRcRangeSelector | {
+    type: string;
+    [key: string]: unknown;
+};
+/** Identifies the part of the message (or a related resource) that the annotation refers to. */
+export interface AnnotationTarget {
+    /** Source resource being targeted. `null` or absent means the first content part of the response. */
+    source?: unknown;
+    /** Character-range or document-region selector within the targeted source. */
+    selector?: AnnotationSelector;
+}
+/** A file attachment referenced by a citation — same shape as `MessageAttachment` but scoped to annotations. */
+export interface AttachmentResource {
+    /** MIME type of the attached file (e.g. `'application/pdf'`). */
+    type: string;
+    /** Remote URL pointing to the file content. */
+    url: string;
+    /** Human-readable display name for the file. Used in citation markers. */
+    title?: string;
+}
+/** Identifies the cited document attached to the annotation. */
+export interface AnnotationSource {
+    /** Always `'attachment'` for file-based sources. */
+    type: 'attachment';
+    /** The cited file — auto-shared by DIAL Core so the recipient can access it. */
+    attachment: AttachmentResource;
+}
+/** Payload of the annotation: the cited text excerpt, its source document, and optional styling hints. */
+export interface AnnotationBody {
+    /** Human-readable title of the cited section or document. */
+    title?: string;
+    /** The literal text excerpt being cited. */
+    quote?: string;
+    /** The cited source document (present when the annotation references a file). */
+    source?: AnnotationSource;
+    /** Selectors pointing to the cited region within the source document. */
+    selector?: AnnotationSelector | AnnotationSelector[];
+    /** Client-defined styling hints (e.g. highlight color). Treated as open-ended; unknown keys are preserved. */
+    configuration?: Record<string, unknown>;
+}
+/** A single annotation attached to an assistant message, optionally citing a source document. */
+export interface Annotation {
+    /** Zero-based position in the annotation list; used to merge streaming delta updates. */
+    index?: number;
+    /** Which part of the message text (or a request resource) is annotated. */
+    target?: AnnotationTarget;
+    /** The annotation payload: quoted text, source document, and optional styling. */
+    body?: AnnotationBody;
+}
+//# sourceMappingURL=annotation.d.ts.map

package/models/annotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["../../src/models/annotation.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,MAAM,WAAW,0BAA0B;IACzC,uDAAuD;IACvD,IAAI,EAAE,sBAAsB,CAAC;IAC7B,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,iFAAiF;AACjF,MAAM,WAAW,eAAe;IAC9B,2CAA2C;IAC3C,IAAI,EAAE,UAAU,CAAC;IACjB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,oGAAoG;AACpG,MAAM,WAAW,eAAe;IAC9B,2CAA2C;IAC3C,IAAI,EAAE,UAAU,CAAC;IACjB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,mIAAmI;IACnI,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,IAAI,EAAE,iBAAiB,CAAC;IACxB,4HAA4H;IAC5H,KAAK,EAAE,MAAM,CAAC;IACd,mFAAmF;IACnF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,IAAI,EAAE,iBAAiB,CAAC;IACxB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+CAA+C;AAC/C,MAAM,WAAW,gBAAgB;IAC/B,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,6BAA6B;IAC7B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,kGAAkG;AAClG,MAAM,WAAW,oBAAoB;IACnC,iDAAiD;IACjD,IAAI,EAAE,gBAAgB,CAAC;IACvB,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,KAAK,EAAE,gBAAgB,CAAC;IACxB,kHAAkH;IAClH,GAAG,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC1B,0BAA0B,GAC1B,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7C,gGAAgG;AAChG,MAAM,WAAW,gBAAgB;IAC/B,qGAAqG;IACrG,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED,gHAAgH;AAChH,MAAM,WAAW,kBAAkB;IACjC,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,gEAAgE;AAChE,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,IAAI,EAAE,YAAY,CAAC;IACnB,gFAAgF;IAChF,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,0GAA0G;AAC1G,MAAM,WAAW,cAAc;IAC7B,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,yEAAyE;IACzE,QAAQ,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC;IACrD,8GAA8G;IAC9G,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACzC;AAED,iGAAiG;AACjG,MAAM,WAAW,UAAU;IACzB,yFAAyF;IACzF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,kFAAkF;IAClF,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB"}

package/models/application-visualizer.d.ts

@@ -0,0 +1,67 @@
+import { CustomVisualizerData, CustomVisualizerDataLayout } from './custom-visualizer';
+/**
+ * A single application → grouped visualizer mapping from the
+ * `APPLICATION_VISUALIZERS` registry. Field semantics are fixed by
+ * already-deployed visualizer applications and operator configurations
+ * carried over from legacy Chat 0.x, which is why `contentType` is optional
+ * here while `CustomVisualizer.contentType` is required.
+ */
+export interface ApplicationVisualizer {
+    /**
+     * The postMessage protocol namespace, NOT a display label. Every message
+     * exchanged with the iframe is prefixed `${title}/…`, and the iframe-side
+     * visualizer application must be constructed with this identical string
+     * as its `appName`. A mismatch is a silent failure — the iframe loads but
+     * never receives data. Also used as the inline frame's header text.
+     */
+    title: string;
+    /** Human-readable description of the visualizer. Accepted for operator-configuration parity; not consumed by host logic. */
+    description?: string;
+    /** Icon URL or identifier for the visualizer. Accepted for operator-configuration parity; not consumed by host logic. */
+    icon?: string;
+    /**
+     * Comma-separated list of MIME types this entry claims (e.g.
+     * `'application/vnd.plotly.v1+json'` or
+     * `'application/vnd.plotly.v1+json, application/vnd.vega.v5+json'`).
+     * Stored verbatim; splitting happens at lookup time. When omitted, the
+     * entry claims every attachment that carries a URL.
+     */
+    contentType?: string;
+    /** Absolute HTTP(S) URL of the visualizer iframe. */
+    url: string;
+    /** Milliseconds to wait for a `send()` request's `/RESPONSE` before rejecting. Defaults to `10000`. Does NOT bound the initial handshake. */
+    requestTimeout?: number;
+    /** Suggested initial width of the visualizer surface in pixels. Forwarded as-is in `CustomVisualizerDataLayout`. */
+    width?: number;
+    /** Suggested initial height of the visualizer surface in pixels. Forwarded as-is in `CustomVisualizerDataLayout`, and used by the host to size the inline frame. */
+    height?: number;
+    /** Suggested height on mobile viewports in pixels. Forwarded as-is in `CustomVisualizerDataLayout`, and used by the host to size the inline frame on mobile. */
+    mobileHeight?: number;
+    /** Whether the host should pass auth info to the visualizer. Accepted for operator-configuration parity; inert, because 1.0 auth is server-side and the browser holds no access token. */
+    passAuthInfo?: boolean;
+    /** Whether the host should pass an explicit access token. Accepted for operator-configuration parity; inert, because 1.0 auth is server-side and the browser holds no access token. */
+    passExplicitToken?: boolean;
+    /** When `true`, the host renders the inline frame without its border, rounded corners, background, and header divider. */
+    borderless?: boolean;
+    /** When `true`, the host hides the inline frame's header title text; the header actions stay visible. */
+    withoutTitle?: boolean;
+}
+/** The `APPLICATION_VISUALIZERS` registry: application id → grouped visualizer entry. */
+export type ApplicationVisualizerRegistry = Record<string, ApplicationVisualizer>;
+/** A single attachment handed to a grouped visualizer inside `SEND_GROUPED_VISUALIZE_DATA`. */
+export interface GroupedAttachmentItem {
+    /** Absolute URL of the attachment, resolved by the host before sending. */
+    url: string;
+    /** The attachment's own MIME type. */
+    mimeType: string;
+    /** Presentation layout plus the opaque per-attachment payload. */
+    visualizerData: CustomVisualizerData;
+}
+/** Payload of a `SEND_GROUPED_VISUALIZE_DATA` request: every claimed attachment plus the shared presentation layout. */
+export interface GroupedAttachmentsData {
+    /** One item per claimed attachment, in the message's attachment order. */
+    attachments: GroupedAttachmentItem[];
+    /** Presentation layout hints shared by every item. */
+    layout: CustomVisualizerDataLayout;
+}
+//# sourceMappingURL=application-visualizer.d.ts.map

package/models/application-visualizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-visualizer.d.ts","sourceRoot":"","sources":["../../src/models/application-visualizer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,0BAA0B,EAC3B,MAAM,qBAAqB,CAAC;AAE7B;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,4HAA4H;IAC5H,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yHAAyH;IACzH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,6IAA6I;IAC7I,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oHAAoH;IACpH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oKAAoK;IACpK,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gKAAgK;IAChK,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0LAA0L;IAC1L,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,uLAAuL;IACvL,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,0HAA0H;IAC1H,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yGAAyG;IACzG,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,yFAAyF;AACzF,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAChD,MAAM,EACN,qBAAqB,CACtB,CAAC;AAEF,+FAA+F;AAC/F,MAAM,WAAW,qBAAqB;IACpC,2EAA2E;IAC3E,GAAG,EAAE,MAAM,CAAC;IACZ,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,cAAc,EAAE,oBAAoB,CAAC;CACtC;AAED,wHAAwH;AACxH,MAAM,WAAW,sBAAsB;IACrC,0EAA0E;IAC1E,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACrC,sDAAsD;IACtD,MAAM,EAAE,0BAA0B,CAAC;CACpC"}

package/models/auth.d.ts

@@ -0,0 +1,26 @@
+/** Authenticated user's profile as returned by the identity provider. */
+export interface UserProfile {
+    /** Subject identifier — unique, stable ID for the user within the provider. */
+    sub: string;
+    /** ID of the identity provider that authenticated the user. */
+    providerId: string;
+    /**
+     * Allowlisted claims, keyed by claim name. A dot-notation provider
+     * `rolesClaim` (e.g. `"realm_access.roles"`) is stored under one flat key
+     * equal to that literal string, never as a nested object — look it up
+     * with `claims[rolesClaim]`, not a nested path.
+     */
+    claims: Record<string, unknown>;
+    /** DIAL Core storage bucket for the authenticated user. Empty string when the bucket has not been resolved yet. */
+    bucket?: string;
+    /** Whether the user's roles claim intersects the provider's configured adminRoles. */
+    isAdmin: boolean;
+}
+/** Describes an available identity provider. */
+export interface ProviderInfo {
+    /** Unique provider identifier used in API calls. */
+    id: string;
+    /** Human-readable display name shown in the UI. */
+    label: string;
+}
+//# sourceMappingURL=auth.d.ts.map

package/models/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/models/auth.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,MAAM,WAAW,WAAW;IAC1B,+EAA+E;IAC/E,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,mHAAmH;IACnH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;CACf"}

package/models/chat.d.ts

@@ -0,0 +1,407 @@
+import { AttachmentErrorReason, AttachmentType } from '../types/attachment';
+import { MIMEType } from '../types/mime-type';
+import { Annotation } from './annotation';
+import { DeploymentConfigurationSchema } from './deployment-configuration';
+import { ResponseFormat } from './deployment-features';
+/** Metadata returned by the DIAL file/conversation listing API for a single resource node. */
+export interface ConversationMetadata {
+    /** Display name of the resource. */
+    name: string;
+    /** Optional author identifier. */
+    author?: string;
+    /** Path of the parent folder in the resource tree. */
+    parentPath: string;
+    /** Storage bucket the resource belongs to. */
+    bucket: string;
+    /** Full resource URL used to fetch or reference the item. */
+    url: string;
+    /** Node type as returned by the backend (e.g. `'ITEM'`, `'FOLDER'`). */
+    nodeType: string;
+    /** Resource type discriminator (e.g. `'Conversation'`). */
+    resourceType: string;
+    /** ETag for optimistic concurrency / cache validation. */
+    etag?: string;
+    /** Unix timestamp (ms) when the resource was created. */
+    createdAt?: number;
+    /** Unix timestamp (ms) of the last modification. */
+    updatedAt?: number;
+    /** Permission strings granted to the current user for this resource. */
+    permissions?: string[];
+}
+/** Identifies the author of a chat message. */
+export declare enum MessageRole {
+    User = "user",
+    Assistant = "assistant",
+    /** In-conversation system event; never sent to DIAL Core. */
+    Status = "status"
+}
+/** User-submitted thumbs-up or thumbs-down rating for an assistant message. */
+export declare enum MessageRating {
+    Like = 1,
+    Dislike = -1
+}
+/** Status of a single agent stage. */
+export declare enum StageStatus {
+    /** The stage completed successfully. */
+    Completed = "completed",
+    /** The stage encountered an error. */
+    Failed = "failed"
+}
+/** Lifecycle status of an assistant message generated by a DIAL Core background Responses job. */
+export declare enum BackgroundGenerationStatus {
+    /** The job is running (or its result has not been saved yet); the message is still being generated. */
+    Pending = "pending",
+    /** The job finished and its final answer is saved. */
+    Completed = "completed",
+    /** The user stopped the generation; the message holds whatever output was available. */
+    Stopped = "stopped",
+    /** The job failed, expired, or could not be started; see `streamErrorMessage`. */
+    Failed = "failed"
+}
+/**
+ * Server-owned association between an assistant message and the DIAL Core background job
+ * producing it. Present only on messages generated through the background path; its
+ * `generationId` identifies the message across saves, because messages have no ids.
+ */
+export interface BackgroundGeneration {
+    /** Client-supplied generation id of the request that started the job. */
+    generationId: string;
+    /** Current lifecycle status of the job's message. */
+    status: BackgroundGenerationStatus;
+    /** Server time (epoch ms) at which the pending placeholder was saved. */
+    startedAt: number;
+}
+/** Permitted scalar/array types for a single form field value. */
+export type MessageFormValueType = number | string | boolean | string[];
+/** Key-value map of field identifiers to form field values, submitted from an embedded form widget. */
+export type MessageFormValue = Record<string, MessageFormValueType | undefined>;
+/** Discriminator values for `StatusMessageCustomContent.event_type`. */
+export declare enum StatusEvent {
+    ModelChanged = "model_changed"
+}
+/** Extra payload attached to a `MessageRole.Status` message. */
+export interface StatusMessageCustomContent {
+    /** Machine-readable event discriminator. */
+    event_type: StatusEvent;
+    /** ID of the deployment that was active before the change, or `null` for the first selection. */
+    previous_deployment_id: string | null;
+    /** ID of the deployment selected after the change. */
+    new_deployment_id: string;
+}
+/**
+ * A skill referenced from `custom_content.skills` — DIAL Core's `RequestSkill`
+ * schema ([ai-dial-core#1956](https://github.com/epam/ai-dial-core/pull/1956)): an object with a non-blank `url`; Core rejects any other
+ * entry shape (e.g. a bare string) with 400.
+ */
+export interface RequestSkill {
+    /** The skill's resource URL (`skills/{bucket}/{path}`) — the same form the skill listing and `CatalogItem.id` use. */
+    url: string;
+}
+/** Extra DIAL API payload attached to a message. */
+export interface MessageCustomContent {
+    /** Files or media items associated with this message. */
+    attachments?: MessageAttachment[];
+    /** Annotations produced by the model, each optionally citing a source document. */
+    annotations?: Annotation[];
+    /** Form field values submitted via an embedded form widget. */
+    form_value?: MessageFormValue;
+    /**
+     * JSON Schema for a button/form widget embedded in an assistant response.
+     * Populated from the streaming delta's `custom_content.form_schema`.
+     */
+    form_schema?: DeploymentConfigurationSchema;
+    /**
+     * Configuration value submitted with the next user turn when a button is selected.
+     * Keys match the `propertyKey` from the `form_schema` (e.g. `{ button: 3 }`).
+     */
+    configuration_value?: Record<string, unknown>;
+    /** Accumulated agent execution stages streamed via `custom_content.stages`. */
+    stages?: Stage[];
+    /**
+     * Opaque app-managed state echoed back verbatim on the next turn, per the DIAL
+     * stateful-app contract. Overwritten (not merged) by each new streaming delta.
+     */
+    state?: Record<string, unknown>;
+    /**
+     * Skills used with this message; each entry carries the skill's resource URL.
+     * Present on user requests and, per Core's contract, on assistant responses
+     * ("skills referenced by the model as part of the response").
+     */
+    skills?: RequestSkill[];
+}
+/** A single message in a conversation. */
+export interface Message {
+    /** Who authored the message. */
+    role: MessageRole;
+    /** Plain-text (or Markdown) message body. */
+    content: string;
+    /** ISO-8601 timestamp of when the message was created. */
+    timestamp: string;
+    /** DIAL Core response identifier used for the rate API. Present on the final chunk. */
+    responseId?: string;
+    /** Extra DIAL API payload; present on user requests and assistant responses. */
+    custom_content?: MessageCustomContent;
+    /** User-submitted rating for this message. */
+    rating?: MessageRating;
+    /** Deployment ID on `MessageRole.Assistant` and `MessageRole.Status` messages. */
+    deploymentId?: string;
+    streamErrorMessage?: string;
+    /** Set on an assistant message whose generation the user stopped; the content is whatever had streamed by then. */
+    wasStoppedByUser?: boolean;
+    /** Set on an assistant message produced by a DIAL Core background job; absent on every other message. */
+    backgroundGeneration?: BackgroundGeneration;
+    /** Allows extra SDK-level properties to pass through when serializing to DIAL Core. */
+    [key: string]: unknown;
+}
+/** In-conversation system event message, always with `role: MessageRole.Status`. */
+export interface StatusMessage extends Omit<Message, 'role' | 'custom_content'> {
+    /** Always `MessageRole.Status` for status messages. */
+    role: MessageRole.Status;
+    /** Status event payload. */
+    custom_content?: StatusMessageCustomContent;
+}
+/** A single agent execution stage produced during a streaming response. */
+export interface Stage {
+    /** Zero-based ordering key; used to merge/upsert incoming stage updates. */
+    index: number;
+    /** Human-readable label for this stage (e.g. `"Lookup available terms"`). */
+    name: string;
+    /** `null` while the stage is running; a `StageStatus` value when it has settled. */
+    status: StageStatus | null;
+    /** Additional text content for this stage, accumulated from streaming chunks. */
+    content?: string;
+    /** File or content attachments associated with this stage. */
+    attachments?: MessageAttachment[];
+    /**
+     * Short source/category label shown beside the step name (e.g. `"MCP"`).
+     * Rendered only when present — never inferred from `name`.
+     */
+    tag?: string;
+    /**
+     * `index` of the stage that produced this one, in the same message's stage
+     * array. In a streaming delta it names the parent's streaming `index` and is
+     * sent only on the chunk that opens the child; in a complete non-streaming
+     * array without indexes it names the parent's array position. Absent for a
+     * top-level stage; `0` is a valid parent.
+     */
+    parent_stage_index?: number;
+}
+/** A single LangChain-style tool-call request emitted by the model, present on a `ToolStateMessage` with `type: 'ai'`. */
+export interface ToolCallRequest {
+    /** Name of the tool being called. */
+    name: string;
+    /** Arguments passed to the tool call. */
+    args: Record<string, unknown>;
+    /** Correlates this call to its result message via that message's `tool_call_id`. */
+    id: string;
+}
+/** One entry in `custom_content.state.tool_messages` — either the model's tool-call request or the tool's result. */
+export interface ToolStateMessage {
+    /** LangChain message type: `'ai'` for the request, `'tool'` for the result. */
+    type: string;
+    /** Present on `type: 'tool'` result messages — the tool's own name. */
+    name?: string;
+    /** Present on `type: 'ai'` messages that requested one or more tool calls. */
+    tool_calls?: ToolCallRequest[];
+    /** Present on `type: 'tool'` result messages — correlates to the request's `id`. */
+    tool_call_id?: string;
+    /** Text content — the tool's result body on `type: 'tool'` messages. */
+    content?: string;
+}
+/** A single OpenAI-style tool-call request, present on a `ToolExecutionHistoryMessage` with `role: 'assistant'`. */
+export interface OpenAiToolCall {
+    /** Correlates this call to its result message via that message's `tool_call_id`. */
+    id: string;
+    /** Always `'function'` for a tool call. */
+    type: string;
+    /** The invoked function's name and raw (unparsed) JSON-encoded arguments. */
+    function: {
+        name: string;
+        /** JSON-encoded arguments object — parse before use. */
+        arguments: string;
+    };
+}
+/** One entry in `custom_content.state.tool_execution_history` — either the model's tool-call request or the tool's result, in OpenAI chat-completion message shape (as opposed to `ToolStateMessage`'s LangChain shape). */
+export interface ToolExecutionHistoryMessage {
+    /** `'assistant'` for the request, `'tool'` for the result. */
+    role: string;
+    /** Present on `role: 'assistant'` messages that requested one or more tool calls. */
+    tool_calls?: OpenAiToolCall[];
+    /** Present on `role: 'tool'` result messages — correlates to the request's `id`. */
+    tool_call_id?: string;
+    /** Text content — the tool's result body on `role: 'tool'` messages. */
+    content?: string;
+}
+/**
+ * Orchestrator-specific execution state, kept wire-verbatim snake_case like
+ * every other pass-through field under `custom_content` (e.g. `stages`) —
+ * not part of any standard DIAL Core contract. Different orchestrators emit
+ * different shapes: `tool_messages` (LangChain-style) is known from the
+ * StatGPT agent, gated behind its own `show_debug_stages` flag;
+ * `tool_execution_history` (OpenAI chat-completion-style) is known from a
+ * different agent. Both are optional and independent — a given orchestrator
+ * emits at most one of them.
+ */
+export interface MessageState {
+    /** The model's tool-call requests and their results for this turn, LangChain-style. */
+    tool_messages?: ToolStateMessage[];
+    /** The model's tool-call requests and their results for this turn, OpenAI chat-completion-style. */
+    tool_execution_history?: ToolExecutionHistoryMessage[];
+}
+/** Incremental content delta inside a streaming SSE chunk. */
+export interface StreamChunkDelta {
+    /** Partial text token appended to the assistant message. */
+    content?: string;
+    /** Role field — only present in the first chunk of a response. */
+    role?: string;
+    /** DIAL Core response identifier used for the rate API. Present on the final chunk. */
+    responseId?: string;
+    /**
+     * Partial custom content carried in this chunk.
+     * `form_schema`, `attachments`, and `stages` may arrive in separate chunks or together in the final chunk.
+     */
+    custom_content?: {
+        /** Incremental stage updates; merge by `index` into the accumulating stage list. */
+        stages?: Stage[];
+        /** JSON Schema for a button/form widget; arrives once the model decides to embed a form. */
+        form_schema?: DeploymentConfigurationSchema;
+        /** AI-generated files produced by the model; typically present in the final chunk. */
+        attachments?: MessageAttachment[];
+        /** Partial annotation updates; merge by `index` into the accumulating annotation list. */
+        annotations?: Annotation[];
+        /** Opaque app-managed state for the DIAL stateful-app contract; overwrites any previous value. */
+        state?: Record<string, unknown>;
+    };
+    /** Raw custom fields in the DIAL wire format. */
+    custom_fields?: {
+        /** Raw annotations in the DIAL wire format; must be normalized before use. */
+        annotations?: unknown[];
+    };
+}
+/** A single server-sent event chunk from the streaming completions endpoint. */
+export interface StreamChunk {
+    /** Unique identifier for the completion stream. */
+    id: string;
+    /** Discriminator — always `'chat.completion.chunk'` for streaming responses. */
+    object: 'chat.completion.chunk';
+    /** One choice per requested completion (usually one entry). */
+    choices: Array<{
+        /** Partial token delta for this chunk. */
+        delta: StreamChunkDelta;
+        /** Set to a non-null string (e.g. `'stop'`) when the stream ends. */
+        finish_reason: string | null;
+        /** Zero-based index of this choice. */
+        index: number;
+    }>;
+    /**
+     * Present when DIAL Core signals an error inside the SSE stream instead of
+     * (or in addition to) a non-2xx HTTP status.
+     */
+    error?: {
+        /** Human-readable error description. */
+        message: string;
+        /** Machine-readable error category (e.g. `'invalid_request_error'`). */
+        type?: string;
+    };
+}
+/** Generic async-operation status, reusable for any request lifecycle. */
+export declare enum RequestStatus {
+    /** No request has been made yet. */
+    Idle = "idle",
+    /** A request is in-flight. */
+    Loading = "loading",
+    /** The most recent request failed. */
+    Error = "error"
+}
+/** Represents a file or content item that can be displayed as an attachment. */
+export interface DisplayAttachment {
+    /** Unique client-side identifier. */
+    id: string;
+    /** Display name (usually the original filename). */
+    name: string;
+    /** MIME type of the attachment (e.g. `'image/png'`, `'application/pdf'`). */
+    contentType: MIMEType | string;
+    /** Content category used to select the correct icon and thumbnail. */
+    type: AttachmentType;
+    /** Upload / processing lifecycle state. */
+    status: RequestStatus;
+    /** Reason the upload failed; only set when `status === RequestStatus.Error`. */
+    errorReason?: AttachmentErrorReason;
+    /** Object URL for image preview; only set when `type === AttachmentType.Image`. */
+    previewUrl?: string;
+    /** Resolved playback URL for audio; only set when `type === AttachmentType.Audio`. */
+    playUrl?: string;
+    /** Remote URL for an attachment that has already been uploaded. */
+    url?: string;
+    /** Alternate reference URL (e.g. from the DIAL API `reference_url` field); used when `url` is absent. */
+    referenceUrl?: string;
+    /** Inline base-64 encoded content; present when the attachment carries data directly rather than via a URL. */
+    data?: string;
+}
+/** Attachment selected locally by the user before it is sent to the backend. */
+export interface Attachment extends DisplayAttachment {
+    /** The underlying browser `File` object selected by the user. */
+    file: File;
+}
+/** Result of successfully uploading an {@link Attachment}. */
+export interface UploadedAttachmentResult {
+    /** The DIAL Core file URL the attachment was uploaded to. */
+    url: string;
+    /** The name actually stored on DIAL Core; differs from the attachment's original name when it contained characters the storage path forbids, or when a ` (n)` suffix was needed to avoid replacing an existing file. */
+    name: string;
+}
+/**
+ * Attachment payload stored in message custom content.
+ * Used inside `Message.custom_content.attachments` for both user requests
+ * and assistant responses.
+ */
+export interface MessageAttachment {
+    /** Zero-based position in the attachment list. */
+    index?: number;
+    /** MIME type of the attachment content. May be absent in streamed runtime payloads. */
+    type?: MIMEType | string;
+    /** Display name shown in the UI. */
+    title: string;
+    /** Inline base-64 encoded content (mutually exclusive with `url`). */
+    data?: string;
+    /** Remote URL pointing to the attachment content. */
+    url?: string;
+    /** MIME type of the referenced resource (used with `reference_url`). */
+    reference_type?: MIMEType | string;
+    /** URL of an alternate reference resource (e.g. a download link). */
+    reference_url?: string;
+}
+/** A full conversation including its messages and configuration. */
+export interface Conversation {
+    /** Unique conversation identifier. */
+    id: string;
+    /** Identifier of the folder this conversation lives in. */
+    folderId: string;
+    /** Human-readable conversation title. */
+    name: string;
+    /** The AI model used for this conversation. */
+    model: {
+        id: string;
+    };
+    /** System prompt prepended to every request. */
+    prompt: string;
+    /** Sampling temperature passed to the model (0–1). */
+    temperature: number;
+    /** Optional Responses-API output-token cap, forwarded as `max_output_tokens`. Never derived from deployment limits or Chat Completions defaults. */
+    maxOutputTokens?: number;
+    /** Ordered list of messages in the conversation. */
+    messages: Message[];
+    /** Unix timestamp (ms) of the most recent activity. */
+    lastActivityDate: number;
+    /** Unix timestamp (ms) of the last save. */
+    updatedAt: number;
+    /** Add-on IDs enabled for this conversation. */
+    selectedAddons: string[];
+    /** Override model ID used when an assistant model is selected. */
+    assistantModelId: string;
+    /** Response format used when rendering messages. */
+    responseFormat?: ResponseFormat;
+    /** Open, feature-keyed container for conversation-level view state. This change owns only the `annotations` key; any other key is opaque and preserved as-is. */
+    customViewState?: Record<string, unknown>;
+}
+//# sourceMappingURL=chat.d.ts.map