@d-id/client-sdk 3.0.0-staging.414 → 3.0.0-staging.415

package/dist/src/types/entities/agents/agent.d.ts

@@ -1,202 +0,0 @@
-import { AvatarType } from '../avatar';
-import { Chat, ChatPayload, ChatResponse } from './chat';
-
-/**
- * The end-of-call feedback form configured on an agent.
- *
- * It describes what to ask the user when the conversation ends; the SDK does not render anything
- * itself. Read it from {@link Agent.end_of_call_feedback}, show your own form when
- * {@link EndOfCallFeedbackConfig.enabled | enabled} is set, and send the result with
- * {@link AgentManager.submitFeedback | submitFeedback()}.
- *
- * @category Agent Manager
- */
-export interface EndOfCallFeedbackConfig {
-    /** Whether the agent is configured to ask for feedback when a call ends. */
-    enabled: boolean;
-    /** The line to show the user as the call ends, before the rating is asked for. */
-    closing_message?: string;
-    /** Whether a free-text follow-up question should be asked after the rating. */
-    follow_up_enabled?: boolean;
-    /**
-     * The follow-up question to ask, chosen by the score the user gave.
-     *
-     * Whichever one you show is what {@link AgentManager.submitFeedback | submitFeedback()} records
-     * as {@link SubmitFeedbackResponse.question_shown | question_shown}.
-     */
-    follow_up_messages?: {
-        /** Question for a score at the low end of the scale. */
-        low?: string;
-        /** Question for a score of 4. */
-        four?: string;
-        /** Question for a score of 5. */
-        five?: string;
-    };
-}
-/**
- * The avatar an agent speaks through: its rendering tier and the language of its voice.
- *
- * The value of {@link Agent.avatar}. Its `type` is the single most important field on an agent: it
- * decides which transport the session uses and therefore which SDK features work.
- *
- * @category Agent Manager
- */
-export interface AgentAvatar {
-    /**
-     * The kind of avatar: {@link AvatarType.Talk | talk} for Talks (V2), {@link AvatarType.Clip | clip}
-     * for Clips (V3), {@link AvatarType.Expressive | expressive} for Expressive (V4).
-     *
-     * Talks (V2) and Clips (V3) agents stream over WebRTC and receive their events on the
-     * notifications web socket; Expressive (V4) agents connect to a real-time session instead, which
-     * is what makes the microphone, camera, client tool and data-channel methods of
-     * {@link AgentManager} available.
-     */
-    type: AvatarType;
-    /** The voice the agent speaks with. */
-    voice?: {
-        /**
-         * Language of the configured voice. The SDK reports it in analytics; it does not change how
-         * the session behaves.
-         */
-        language?: string;
-    };
-}
-/**
- * An agent's profile, as the Agents API returns it.
- *
- * The SDK fetches it once while {@link createAgentManager} runs and exposes it as
- * {@link AgentManager.agent}, so everything here is available before
- * {@link AgentManager.connect | connect()} — which is what makes it useful for rendering the agent
- * before the video exists. The fields are the agent's configuration, whether it was set in D-ID Studio
- * or through the Agents API; most of them are for the application to use, and each one below says
- * where the SDK itself reads it.
- *
- * @see [Get an agent](https://docs.d-id.com/reference/agent-get)
- * @category Agent Manager
- */
-export interface Agent {
-    /** Id of the agent: the same value passed to {@link createAgentManager}. */
-    id: string;
-    /** Id of the D-ID account that owns the agent. Set by the Agents API. */
-    owner_id?: string;
-    /** The agent's display name. */
-    name?: string;
-    /** `'public'` when the agent is configured for public access; omitted otherwise. */
-    access?: 'public';
-    /** URL of the agent's still image. Use it as the poster of your video element before
-     * {@link AgentManager.connect | connect()} has a stream to show. */
-    thumbnail?: string;
-    /**
-     * The greeting lines configured for the agent.
-     *
-     * The SDK never speaks them by itself: pass one to {@link AgentManager.speak | speak()} once
-     * the agent is connected if you want the agent to open the conversation. Check what your own
-     * agent does first — an Expressive (V4) session's server side may greet on its own, in which
-     * case speaking a greeting as well says it twice.
-     */
-    greetings?: string[];
-    /**
-     * Suggested opening questions to offer the user.
-     *
-     * The SDK surfaces the same array as {@link AgentManager.starterMessages | starterMessages}.
-     */
-    starter_message?: string[];
-    /**
-     * URL of the agent's looping idle video.
-     *
-     * Show it while the agent is not speaking: put it on your video element's `src` when
-     * {@link AgentManagerCallbacks.onVideoStateChange | onVideoStateChange} reports `STOP`.
-     */
-    idle_video?: string;
-    /**
-     * The knowledge base attached to the agent, when it has one.
-     *
-     * Its presence is what tells you the agent can cite sources; the citations themselves arrive on
-     * each answer as {@link Message.matches | matches}.
-     */
-    knowledge?: {
-        /**
-         * Id of the knowledge base.
-         *
-         * The SDK sends it with every rating made by {@link AgentManager.rate | rate()}, and it is
-         * the {@link RetrievalMetadata.knowledge_id | knowledge_id} of the citations on an answer.
-         */
-        id: string;
-        /** The embedding model the knowledge base was indexed with. The SDK does not act on it. */
-        embedder?: {
-            /** Whether that embedding model covers only a limited set of languages, so knowledge
-             * written in another language may not be retrieved well. */
-            is_limited_language?: boolean;
-        };
-    };
-    /**
-     * The avatar the agent is built on.
-     *
-     * Its `type` is the single most important field on an agent: it decides which transport the
-     * session uses and therefore which SDK features work. See {@link AgentAvatar}.
-     */
-    avatar: AgentAvatar;
-    /**
-     * Whether vision is enabled for the agent.
-     *
-     * Exposed so an application can decide whether to offer the camera; the SDK does not read it,
-     * and publishing a camera stream is an Expressive (V4) feature — see
-     * {@link AgentManager.publishCameraStream | publishCameraStream()}.
-     */
-    vision?: {
-        /** `true` when the agent is configured to use the user's camera. */
-        enabled: boolean;
-    };
-    /**
-     * The end-of-call feedback form configured for the agent.
-     *
-     * The SDK does not read it: render your own form from it and submit the result with
-     * {@link AgentManager.submitFeedback | submitFeedback()}. See
-     * {@link EndOfCallFeedbackConfig}.
-     */
-    end_of_call_feedback?: EndOfCallFeedbackConfig;
-    /** Whether the agent has triggers configured. The SDK does not act on them. */
-    triggers_available?: boolean;
-    /** Settings that change how D-ID's own surfaces present the agent. */
-    advanced_settings?: {
-        /**
-         * Whether the SDK logs its streaming lifecycle to the browser console.
-         *
-         * When it is enabled the SDK turns debug logging on for every visitor, whatever
-         * {@link AgentManagerOptions.debug | debug} was passed to {@link createAgentManager}.
-         */
-        ui_debug_mode?: boolean;
-        /**
-         * Account the agent's rendering VM is billed to.
-         *
-         * @internal D-ID internal; not part of the public SDK contract.
-         */
-        vm_account_id?: string;
-        /** Whether the embedding UI should show closed captions. The SDK does not act on it. */
-        closed_captions_enabled?: boolean;
-    };
-    /**
-     * Feature-flag targeting context for the account this agent belongs to.
-     *
-     * @internal D-ID internal; not part of the public SDK contract.
-     */
-    ld_context?: {
-        /** Key identifying the context. */
-        key: string;
-        /** Hashed form of the key. */
-        hash_key: string;
-        /** The plan group the account falls into. */
-        plan_group: string;
-    };
-}
-/**
- * Internal HTTP client surface used by the agent manager to talk to the Agents API.
- * @internal Implementation type; not part of the public SDK surface.
- */
-export interface AgentsAPI {
-    getRuntimeById(id: string, options?: RequestInit): Promise<Agent>;
-    newChat(agentId: string, payload: {
-        persist: boolean;
-    }, options?: RequestInit): Promise<Chat>;
-    chat(agentId: string, chatId: string, payload: ChatPayload, options?: RequestInit): Promise<ChatResponse>;
-}

package/dist/src/types/entities/agents/chat.d.ts

@@ -1,476 +0,0 @@
-/**
- * A rating stored against one message of a chat, as the Agents API returns it.
- *
- * Produced by {@link AgentManager.rate | rate()} and returned again by
- * {@link AgentManager.deleteRate | deleteRate()}. Keep {@link Rating.id | id} if the user may
- * change their mind: pass it back to {@link AgentManager.rate | rate()} as `rateId` to update the
- * rating, or to {@link AgentManager.deleteRate | deleteRate()} to remove it.
- *
- * @category Chat
- */
-export interface Rating {
-    /**
-     * Id of this rating.
-     *
-     * Pass it as the `rateId` argument of {@link AgentManager.rate | rate()} to update the rating,
-     * or to {@link AgentManager.deleteRate | deleteRate()} to remove it.
-     */
-    id: string;
-    /** Id of the D-ID account that owns the agent the rating was left on. Set by the Agents API. */
-    owner_id: string;
-    /** Id of the agent whose answer was rated. */
-    agent_id: string;
-    /**
-     * The knowledge citations that were attached to the rated answer, as `[document_id, id]` pairs.
-     *
-     * The SDK builds them from the {@link Message.matches | matches} of the rated message, so a
-     * negative rating can be traced back to the documents the answer was drawn from. Empty when the
-     * answer cited nothing.
-     */
-    matches: [string, string][];
-    /**
-     * Id of the agent's knowledge base ({@link Agent.knowledge}) at the time of the rating.
-     *
-     * An empty string when the agent has no knowledge base.
-     */
-    knowledge_id: string;
-    /**
-     * The end-user identifier the Agents API recorded for the request.
-     *
-     * Derived from the credentials the SDK sends, which carry
-     * {@link AgentManagerOptions.externalId | externalId} for `type: 'key'` authorization.
-     */
-    external_id: string;
-    /** Identity the Agents API attributed the rating to. Set by the Agents API. */
-    created_by: string;
-    /** Id of the chat the rated message belongs to — the value
-     * {@link AgentManagerCallbacks.onNewChat | onNewChat} reported. */
-    chat_id: string;
-    /** The score itself: `1` for a positive rating, `-1` for a negative one. */
-    score: 1 | -1;
-    /** When the rating was created, as an ISO 8601 timestamp. */
-    created_at: string;
-    /** When the rating was last changed, as an ISO 8601 timestamp. */
-    modified_at: string;
-    /** {@link Message.id | Id of the message} that was rated. */
-    message_id: string;
-}
-/**
- * Request payload for rating a chat message, derived from `Rating`.
- * @internal Implementation type; not part of the public SDK surface.
- */
-export type RatingPayload = Omit<Rating, 'owner_id' | 'id' | 'created_at' | 'modified_at' | 'created_by' | 'external_id' | 'agent_id' | 'chat_id'>;
-/**
- * What the Agents API stored when end-of-call feedback was submitted.
- *
- * Returned by {@link AgentManager.submitFeedback | submitFeedback()}, which rates the conversation
- * as a whole rather than a single answer.
- *
- * @category Chat
- */
-export interface SubmitFeedbackResponse {
-    /** Id of the chat the feedback belongs to — the value
-     * {@link AgentManagerCallbacks.onNewChat | onNewChat} reported. */
-    chat_id: string;
-    /** The score that was submitted, on the agent's end-of-call scale of 1 to 5. */
-    rating: number;
-    /**
-     * The follow-up question the user was asked, when one was recorded.
-     *
-     * Applications pick it from {@link EndOfCallFeedbackConfig.follow_up_messages}.
-     */
-    question_shown?: string;
-    /** When the feedback was stored, as an ISO 8601 timestamp. */
-    submitted_at: string;
-}
-/**
- * One renderable piece of a message: a run of text, an image, a video or a link.
- *
- * {@link parseMessageParts} splits a message's {@link Message.content | content} into these, and
- * the SDK keeps the result on {@link Message.parts}. Switch on `type` when rendering. Anything the
- * parser did not recognise is preserved verbatim as a `text` part, in its original order, and
- * nothing is dropped or reordered; a recognised image, video or link replaces the markup it was
- * written as, so the parts are not a concatenation of the original string.
- *
- * @category Chat
- */
-export type MessagePart = {
-    /** Discriminant: plain text that the parser found no markup in. */
-    type: 'text';
-    /** The text itself, exactly as it appeared in {@link Message.content}. */
-    text: string;
-} | {
-    /** Discriminant: an image, from markdown image syntax such as `![alt](url)`. */
-    type: 'image';
-    /** URL of the image. */
-    src: string;
-    /** The alt text from the markdown, or an empty string when it had none. */
-    alt: string;
-    /**
-     * `image/gif` when the URL itself ends in `.gif`, ignoring case; absent otherwise.
-     *
-     * The check looks at the whole URL, so a query string or fragment suppresses it —
-     * `cat.gif?v=2` carries no `mimeType`. Video detection differs: it strips both before
-     * looking at the extension.
-     */
-    mimeType?: string;
-} | {
-    /**
-     * Discriminant: a video, either from thumbnail syntax (`[![alt](thumb)](video)`) or from
-     * an image whose URL ends in `.mp4`, `.webm`, `.mkv`, `.mov`, `.m4v` or `.ogv` once any
-     * query string and fragment have been stripped.
-     */
-    type: 'video';
-    /** URL of the video file. */
-    src: string;
-    /** The alt text from the markdown, or an empty string when it had none. */
-    alt: string;
-    /** URL of the poster image, when the thumbnail syntax supplied one. */
-    thumbnail?: string;
-} | {
-    /** Discriminant: a link, from markdown `[label](url)` or from an HTML `<a href>`. */
-    type: 'link';
-    /** Target of the link. */
-    href: string;
-    /** The text shown for the link. */
-    label: string;
-};
-/**
- * One message of a chat: what the user asked, or what the agent answered.
- *
- * The SDK keeps the whole transcript and hands a fresh copy of it to
- * {@link AgentManagerCallbacks.onNewMessage | onNewMessage} every time a message is added or
- * changed, oldest first. While an answer streams in, the last message's
- * {@link Message.content | content} and {@link Message.parts | parts} are replaced with the latest
- * text on each `partial` callback — not appended to — and are final on `answer`. The same shape is
- * accepted by {@link AgentManagerOptions.initialMessages | initialMessages} to seed a transcript.
- *
- * @category Chat
- */
-export interface Message {
-    /**
-     * Id of this message.
-     *
-     * Pass it to {@link AgentManager.rate | rate()} to rate the answer. The SDK generates a random
-     * id for the messages it creates locally, and uses the id sent with the message for those that
-     * arrive from the agent.
-     */
-    id: string;
-    /**
-     * Who the message is from.
-     *
-     * The SDK itself only creates `user` (the end user) and `assistant` (the agent) messages; the
-     * value on a transcribed or streamed message is whatever the server payload carried. `system`,
-     * `function` and `tool` exist because the underlying chat protocol allows them.
-     */
-    role?: 'system' | 'assistant' | 'user' | 'function' | 'tool';
-    /**
-     * The message text.
-     *
-     * Plain text, which for agent answers may contain markdown. It is replaced by the latest text
-     * on every `partial` callback while the answer streams in — and the final `answer` may be
-     * shorter than the partials before it, which is exactly how the SDK spots an interruption — so
-     * render it as it is rather than appending to what you rendered before.
-     */
-    content: string;
-    /**
-     * {@link Message.content | content} split into renderable pieces by {@link parseMessageParts}.
-     *
-     * Kept in step with `content` on every message the SDK creates, including while an answer
-     * streams in. Render these instead of the raw string when the agent may answer with images,
-     * videos or links; a message with no markup is a single `text` part, and an empty message is
-     * an empty array.
-     *
-     * {@link AgentManagerOptions.initialMessages | initialMessages} are treated the same way: the
-     * SDK runs the parser over the `content` of any of them that arrives with empty or missing
-     * `parts`, so a restored transcript can pass `parts: []` and still render. A non-empty array
-     * you built yourself is kept exactly as given.
-     */
-    parts: MessagePart[];
-    /** When the message was added, as an ISO 8601 timestamp. */
-    createdAt?: string;
-    /**
-     * The knowledge citations the answer was drawn from, as {@link RetrievalMetadata} entries.
-     *
-     * Present on an agent answer when the chat response carried them, so a UI can show its sources;
-     * {@link AgentManager.rate | rate()} also sends them with a rating. The SDK strips this field
-     * from the transcript it sends back to the Agents API with the next
-     * {@link AgentManager.chat | chat()}.
-     */
-    matches?: ChatResponse['matches'];
-    /**
-     * The retrieved context the answer was generated from, as
-     * {@link ChatResponse.context | the chat response} supplied it.
-     *
-     * Only ever set on an agent answer, and only when the answer came back from the Agents API.
-     * Expressive (V4) agents chat over the data channel instead, so their answers carry no context
-     * — except in {@link ChatMode.Playground}, which always takes the Agents API path.
-     */
-    context?: string;
-    /**
-     * `true` when the answer was cut short instead of being spoken to the end.
-     *
-     * Set on the last message by {@link AgentManager.interrupt | interrupt()}, and by the SDK when
-     * the final answer turns out to be shorter than the partial text already received — which is
-     * how it detects that the agent was interrupted mid-utterance.
-     */
-    interrupted?: boolean;
-    /**
-     * `true` when this user message came from speech-to-text rather than from
-     * {@link AgentManager.chat | chat()}.
-     *
-     * It is what distinguishes an utterance the user spoke from one they typed.
-     */
-    transcribed?: boolean;
-    /**
-     * The sentiment the agent delivered this answer with, when the stream reported one.
-     *
-     * Taken from the metadata the server sends with the video it created, and attached to the most
-     * recent agent answer. The SDK only ever fills it in from an Expressive (V4) session, and only
-     * while {@link AgentManagerOptions.debug | debug} is enabled.
-     */
-    sentiment?: MessageSentiment;
-}
-/**
- * The sentiment an agent answer was delivered with, as the server reported it.
- *
- * The shape of {@link Message.sentiment}. It is an object rather than a string because the server
- * reports both the id of the sentiment it used and its name, where
- * {@link TextStreamScript.sentiment} — the sentiment the application *asks* for — is just the
- * name.
- *
- * @category Chat
- */
-export interface MessageSentiment {
-    /** Id of the sentiment, as the server sent it. */
-    id: string;
-    /** Name of the sentiment, as the server sent it. */
-    name: string;
-}
-/**
- * Request payload for sending a chat message to the Agents API.
- * @internal Implementation type; not part of the public SDK surface.
- */
-export interface ChatPayload {
-    messages: Message[];
-    streamId?: string;
-    sessionId?: string;
-    chatMode?: ChatMode;
-}
-/**
- * One knowledge citation: the passage of the agent's knowledge base an answer was drawn from.
- *
- * The Agents API returns these with an answer and the SDK keeps them on
- * {@link Message.matches | matches}, so a UI can show the sources behind a reply.
- *
- * @category Chat
- */
-export interface RetrievalMetadata {
-    /** Id of this match. Sent back with a rating as the second half of a
-     * {@link Rating.matches} pair. */
-    id: string;
-    /** The matched passage itself, as stored in the knowledge base. */
-    data: string;
-    /** Title of the document the passage comes from. */
-    title: string;
-    /** Id of the source document. Sent back with a rating as the first half of a
-     * {@link Rating.matches} pair. */
-    document_id: string;
-    /** Id of the knowledge base the document belongs to — the agent's {@link Agent.knowledge}. */
-    knowledge_id: string;
-    /** URL of the original source, for linking the citation out of the chat. */
-    source_url: string;
-}
-/**
- * How the agent answers: with a streamed video, as text only, or not at all.
- *
- * Chosen with {@link AgentManagerOptions.mode | mode} and changed later with
- * {@link AgentManager.changeMode | changeMode()}, which reports the new value through
- * {@link AgentManagerCallbacks.onModeChange | onModeChange}. Switching to anything other than
- * {@link ChatMode.Functional} disconnects the stream. What the mode decides at creation time is
- * narrower than it looks: whether a chat is created for the session, and whether the notifications
- * web socket is opened. {@link AgentManager.connect | connect()} establishes the video stream in
- * every mode. The server can also answer with a different mode than the one asked for when the chat
- * is created; the SDK then adopts it and reports a {@link ChatModeDowngraded} error through
- * {@link AgentManagerCallbacks.onError | onError}.
- *
- * @category Chat
- */
-export declare enum ChatMode {
-    /**
-     * Chat and video: the agent answers questions with its own LLM, in a streamed video.
-     *
-     * The default when {@link AgentManagerOptions.mode | mode} is omitted, and the only mode a
-     * session can be in while a stream is connected and chat is available at the same time:
-     * {@link AgentManager.changeMode | changeMode()} to any other value disconnects the stream.
-     */
-    Functional = "Functional",
-    /**
-     * Text answers only: the chat works, but no video is produced.
-     *
-     * {@link AgentManager.chat | chat()} still returns answers through
-     * {@link AgentManagerCallbacks.onNewMessage | onNewMessage}, and
-     * {@link AgentManager.speak | speak()} adds a text script to the transcript but streams no
-     * video: it resolves with a `duration` of `0` and an empty `videoId`.
-     */
-    TextOnly = "TextOnly",
-    /**
-     * The agent is unavailable: {@link AgentManager.chat | chat()} throws a
-     * {@link ValidationError}.
-     *
-     * The SDK switches to it by itself when connecting fails after its retries, so a UI can show
-     * that the agent is temporarily out of service; the server can also return it when a chat is
-     * created. Like {@link ChatMode.TextOnly} it produces no video.
-     */
-    Maintenance = "Maintenance",
-    /**
-     * A text-only test conversation, used by the agent playground in D-ID Studio.
-     *
-     * Produces no video, and marks each chat request with a playground header so the Agents API
-     * can treat it as a test. Chats in this mode always go over the Agents API, even for
-     * Expressive (V4) agents, which otherwise chat over the data channel. Applications normally
-     * use {@link ChatMode.Functional} or {@link ChatMode.TextOnly} instead.
-     */
-    Playground = "Playground",
-    /**
-     * Speak-only: no chat is created for the session, while video still streams.
-     *
-     * Talks (V2) and Clips (V3) agents only; {@link createAgentManager} and
-     * {@link AgentManager.changeMode | changeMode()} reject it with a {@link ValidationError} for
-     * Expressive (V4) agents.
-     *
-     * {@link AgentManager.chat | chat()} throws a {@link ValidationError} — but only when this was
-     * the mode {@link createAgentManager} was given, because that guard reads the creation-time
-     * mode rather than the current one; arriving here later through
-     * {@link AgentManager.changeMode | changeMode()} leaves {@link AgentManager.chat | chat()}
-     * working. Chosen at creation time it also skips the notifications web socket. Use it when
-     * the application drives the agent entirely through {@link AgentManager.speak | speak()} and
-     * never asks its LLM anything. The stream keeps running only when this is the mode
-     * {@link createAgentManager} was given; switching into it later with
-     * {@link AgentManager.changeMode | changeMode()} disconnects the stream like any other
-     * non-{@link ChatMode.Functional} mode.
-     */
-    DirectPlayback = "DirectPlayback",
-    /**
-     * Chat is switched off: no chat is created for the session, while video still streams.
-     *
-     * Talks (V2) and Clips (V3) agents only; {@link createAgentManager} and
-     * {@link AgentManager.changeMode | changeMode()} reject it with a {@link ValidationError} for
-     * Expressive (V4) agents.
-     *
-     * {@link AgentManager.chat | chat()} throws a {@link ValidationError} under the same
-     * creation-time rule as {@link ChatMode.DirectPlayback}. The one difference between the two is
-     * the notifications web socket: this mode still opens it on a Talks (V2) or Clips (V3) agent,
-     * where {@link ChatMode.DirectPlayback} skips it. As with {@link ChatMode.DirectPlayback}, the
-     * stream keeps running only when this is the mode set at creation; switching into it later with
-     * {@link AgentManager.changeMode | changeMode()} disconnects the stream.
-     */
-    Off = "Off"
-}
-/**
- * What the Agents API answers a chat request with.
- *
- * Returned by {@link AgentManager.chat | chat()}. The SDK has already added the answer to the
- * transcript by the time you get it, so most applications render
- * {@link AgentManagerCallbacks.onNewMessage | onNewMessage} instead and use this only for the
- * fields that never reach a {@link Message}. Expressive (V4) agents chat over the data channel
- * rather than over the Agents API — except in {@link ChatMode.Playground} — so for them the
- * object is empty and the answer arrives through the callback.
- *
- * @category Chat
- */
-export interface ChatResponse {
-    /**
-     * The agent's answer.
-     *
-     * Empty or absent when the answer is delivered as it is generated instead, which is what
-     * streaming modes do; the SDK then adds no message for it and the text arrives through
-     * {@link AgentManagerCallbacks.onNewMessage | onNewMessage}.
-     */
-    result?: string;
-    /**
-     * The Agents API's own list of ids for the documents behind the answer. The SDK never reads it;
-     * {@link ChatResponse.matches | matches} is what it keeps on the message.
-     */
-    documentIds?: string[];
-    /**
-     * The knowledge citations behind the answer.
-     *
-     * Copied onto the answer as {@link Message.matches | matches}.
-     */
-    matches?: RetrievalMetadata[];
-    /**
-     * The {@link ChatMode} the server handled the request in.
-     *
-     * It can differ from the mode that was asked for — see {@link ChatMode}.
-     */
-    chatMode?: ChatMode;
-    /**
-     * The retrieved context the answer was generated from.
-     *
-     * Copied onto the answer as {@link Message.context | context}.
-     */
-    context?: string;
-    /** Id of the video generated for the answer, when the server reported one. */
-    videoId?: string;
-}
-/**
- * A conversation with an agent, as the Agents API stores it.
- * @internal Wire type of the Agents API; not part of the public SDK surface. The only part an
- * application sees is the chat id, reported by
- * {@link AgentManagerCallbacks.onNewChat | onNewChat}.
- */
-export interface Chat {
-    /** Id of the chat. The value handed to
-     * {@link AgentManagerCallbacks.onNewChat | onNewChat}. */
-    id: string;
-    /** Id of the agent this conversation is with. */
-    agent_id: string;
-    /** When the chat was created, as an ISO 8601 timestamp. */
-    created: string;
-    /** When the chat was last changed, as an ISO 8601 timestamp. */
-    modified: string;
-    /** Id of the D-ID account that owns the chat. Set by the API; on the synthetic chat the SDK
-     * builds for an Expressive (V4) session it is copied from {@link Agent.owner_id}. */
-    owner_id: string;
-    /**
-     * The messages stored with the chat.
-     *
-     * The SDK never reads this array — the live transcript is the one handed to
-     * {@link AgentManagerCallbacks.onNewMessage | onNewMessage} — and it is empty on the chat the
-     * SDK builds for an Expressive (V4) session.
-     */
-    messages: Message[];
-    /** A composite sort key the API uses to list an agent's chats by creation time. Not meaningful
-     * to clients. */
-    agent_id__created_at: string;
-    /** A composite sort key the API uses to list an agent's chats by modification time. Not
-     * meaningful to clients. */
-    agent_id__modified_at: string;
-    /**
-     * The {@link ChatMode} the chat was created in.
-     *
-     * {@link AgentManager.connect | connect()} adopts it, which is how the server can downgrade the
-     * mode an application asked for.
-     */
-    chat_mode?: ChatMode;
-}
-/**
- * What caused the user to interrupt the agent, passed to
- * {@link AgentManager.interrupt | interrupt()}.
- *
- * @category Chat
- */
-export interface InterruptOptions {
-    /**
-     * The cause: `text` when the user typed over the answer, `audio` when they started speaking,
-     * `click` when they pressed a stop control, and `manual` for an interruption the application
-     * decided on itself.
-     *
-     * The SDK records it with the interruption for analytics. It changes behaviour in one case
-     * only: Expressive (V4) agents ignore a `text` interrupt, because their orchestrator does not
-     * cancel the answer already in flight. Talks (V2) and Clips (V3) agents interrupt the current
-     * video whatever the value.
-     */
-    type: 'text' | 'audio' | 'click' | 'manual';
-}

package/dist/src/types/entities/agents/index.d.ts

@@ -1,3 +0,0 @@
-export * from './agent';
-export * from './chat';
-export * from './manager';