@d-id/client-sdk 2.0.10-staging.411 → 3.0.0-staging.412

package/dist/src/types/entities/avatar.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The kind of avatar an agent is built on, which is what decides how its video is produced.
+ *
+ * It is the `type` of the agent's avatar ({@link Agent.avatar}) and so determines which SDK
+ * features a session has: {@link AvatarType.Talk | talk} is Talks (V2),
+ * {@link AvatarType.Clip | clip} is Clips (V3), and {@link AvatarType.Expressive | expressive} is
+ * Expressive (V4).
+ *
+ * @category Agent Manager
+ */
+export declare enum AvatarType {
+    /** A Clips (V3) agent: a pre-recorded presenter, driven by the D-ID Clips pipeline. */
+    Clip = "clip",
+    /** A Talks (V2) agent: a still photo animated to speak. */
+    Talk = "talk",
+    /**
+     * An Expressive (V4) avatar: a real-time avatar that also supports microphone and camera
+     * publishing, client tools and interruption.
+     */
+    Expressive = "expressive"
+}

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

@@ -1,3 +1,3 @@
 export * from './agents';
+export * from './avatar';
 export * from './knowledge';
-export * from './video';

package/dist/src/types/entities/knowledge/document.d.ts

@@ -4,18 +4,13 @@ import { DocumentType, KnowledgeType } from './knowledge';
  * Lifecycle status of a document, as served by the knowledge API. The API stores the
  * status as a prefixed event subject (`document/done`) but strips the prefix on read,
  * so the wire value is always bare.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
  */
 export type DocumentStatus = 'created' | 'processed' | 'done' | 'rejected' | 'error';
 /**
- * @deprecated The knowledge API has never served these prefixed values — it strips the
- * subject prefix on read. Use `DocumentStatus` instead. Kept for backwards compatibility
- * and will be removed in the next major.
+ * A document as returned by the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
  */
-export declare enum Subject {
-    KnowledgeProcessing = "knowledge/processing",
-    KnowledgeFailed = "knowledge/error",
-    KnowledgeDone = "knowledge/done"
-}
 export interface DocumentData {
     created_at: string;
     modified_at: string;
@@ -29,4 +24,8 @@ export interface DocumentData {
     parsed_url: string;
     title: string;
 }
+/**
+ * Request payload for creating a document, derived from `DocumentData`.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export type CreateDocumentPayload = Omit<DocumentData, 'created_by' | 'parsed_url' | 'status' | 'type' | 'created_at' | 'modified_at' | 'id' | 'owner_id'>;

package/dist/src/types/entities/knowledge/knowledge.d.ts

@@ -1,8 +1,16 @@
+/**
+ * Kind of a knowledge entity as stored by the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export declare enum KnowledgeType {
     Knowledge = "knowledge",
     Document = "document",
     Record = "record"
 }
+/**
+ * File format of a document ingested into the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export declare enum DocumentType {
     Pdf = "pdf",
     Text = "text",
@@ -18,9 +26,17 @@ export declare enum DocumentType {
     Audio = "audio",
     Video = "video"
 }
+/**
+ * Result of parsing a document's raw content for the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export interface IParserResult {
     data: string;
 }
+/**
+ * A knowledge entity as returned by the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export interface KnowledgeData {
     created_at: string;
     modified_at: string;
@@ -33,4 +49,8 @@ export interface KnowledgeData {
     name: string;
     starter_message?: string[];
 }
+/**
+ * Request payload for creating a knowledge entity, derived from `KnowledgeData`.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export type KnowledgePayload = Omit<KnowledgeData, 'created_by' | 'type' | 'created_at' | 'modified_at' | 'id' | 'owner_id'>;

package/dist/src/types/entities/knowledge/record.d.ts

@@ -1,5 +1,9 @@
 import { KnowledgeType } from './knowledge';
 
+/**
+ * A record (chunk of a document) as returned by the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export interface RecordData {
     created_at: string;
     modified_at: string;
@@ -13,4 +17,8 @@ export interface RecordData {
     title: string;
     data: string;
 }
+/**
+ * Request payload for creating a record, derived from `RecordData`.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export type CreateRecordPayload = Omit<RecordData, 'created_by' | 'type' | 'created_at' | 'modified_at' | 'id' | 'owner_id'>;

package/dist/src/types/entities/knowledge/retrival.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Result of a knowledge-base query against the Knowledge API.
+ * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
+ */
 export interface QueryResult {
     documentIds: string[];
     result: any;

package/dist/src/types/stream/api/clip.d.ts

@@ -24,16 +24,11 @@ interface ClipConfig {
      */
     result_format?: 'mp4' | 'gif' | 'mov' | 'webm';
 }
+/**
+ * Wire request body for creating a clip stream.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface CreateClipStreamRequest {
-    /**
-     * The output resolution sets the maximum height or width of the streamed video.
-     * The aspect ratio is preserved from the source video.
-     * When resolution is not configured, it defaults to the agent output resolution.
-     * @minimum 150
-     * @maximum 1080
-     * @example 512
-     */
-    output_resolution?: number;
     /**
      * Defines the video codec to be used in the stream.
      * When set to on: VP8 will be used.
@@ -56,6 +51,10 @@ export interface CreateClipStreamRequest {
      */
     session_timeout?: number;
 }
+/**
+ * Wire payload sent to advance a clip stream with a new script.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface SendClipStreamPayload extends StickyRequest {
     script: StreamScript;
     /**

package/dist/src/types/stream/api/talk.d.ts

@@ -1,6 +1,10 @@
 import { StreamScript } from '../..';
 import { CompatibilityMode } from '../stream';
 
+/**
+ * Wire request body for creating a legacy (talk) stream.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface CreateTalkStreamRequest {
     driver_url?: string;
     face?: {
@@ -21,15 +25,6 @@ export interface CreateTalkStreamRequest {
         align_expand_factor?: number;
         stitch?: boolean;
     };
-    /**
-     * The output resolution sets the maximum height or width of the streamed video.
-     * The aspect ratio is preserved from the source image.
-     * When resolution is not configured, it defaults to the agent output resolution.
-     * @minimum 150
-     * @maximum 1080
-     * @example 512
-     */
-    output_resolution?: number;
     /**
      * Defines the video codec to be used in the stream.
      * When set to on: VP8 will be used.
@@ -52,6 +47,10 @@ export interface CreateTalkStreamRequest {
      */
     session_timeout?: number;
 }
+/**
+ * Wire payload sent to advance a talk stream with a new script.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface SendTalkStreamPayload {
     script: StreamScript;
     resultUrl?: string;

package/dist/src/types/stream/rtc.d.ts

@@ -1,7 +1,8 @@
+/**
+ * Carrier of the `session_id` that keeps successive streaming requests on the same server session.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface StickyRequest {
-    /**
-     * session identifier information, should be returned in the body of all streaming requests
-     */
     session_id?: string;
 }
 interface Jsep {
@@ -14,6 +15,10 @@ interface Jsep {
      */
     sdp: string;
 }
+/**
+ * STUN/TURN server credentials returned by the Agents API for establishing the WebRTC connection.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface IceServer {
     /**
      * URL of the server - can be multiple addresses
@@ -28,6 +33,10 @@ export interface IceServer {
      */
     credential?: string;
 }
+/**
+ * Response of `POST /agents/{id}/streams`: the SDP offer and ICE servers for the WebRTC handshake.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface ICreateStreamRequestResponse extends StickyRequest {
     id: string;
     jsep: Jsep;
@@ -36,6 +45,10 @@ export interface ICreateStreamRequestResponse extends StickyRequest {
     fluent?: boolean;
     interrupt_enabled?: boolean;
 }
+/**
+ * A single ICE candidate exchanged during the WebRTC connection handshake.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface IceCandidate {
     /**
      * A string representing the transport address for the candidate that can be used for connectivity checks.
@@ -54,11 +67,48 @@ export interface IceCandidate {
      */
     sdpMLineIndex?: number;
 }
+/**
+ * Bare `{ status }` envelope returned by the streaming endpoints that report only success or failure.
+ * @internal Wire type of the streaming transport; not part of the public SDK surface.
+ */
 export interface Status {
     status: string;
 }
-export interface SendStreamPayloadResponse extends Status, StickyRequest {
+/**
+ * What {@link AgentManager.speak | speak()} resolves with: the video the agent is about to stream.
+ *
+ * The fields come from the Talks (V2) and Clips (V3) API, which generates a discrete video while
+ * answering the request. Where no such video exists the call still resolves, with the same stub —
+ * `status` `'success'`, `duration` `0` and an empty `video_id`: on Expressive (V4) agents, whose
+ * speech is streamed over the data channel rather than rendered as a separate video, and in a
+ * text-only chat mode ({@link ChatMode.TextOnly}, {@link ChatMode.Playground} or
+ * {@link ChatMode.Maintenance}), which produces no video at all.
+ *
+ * @category Speak & Scripts
+ */
+export interface SendStreamPayloadResponse {
+    /**
+     * Whether the server accepted the speak request — `'success'` when it did.
+     */
+    status: string;
+    /**
+     * Id of the session this call was made on; the SDK sends it back on later streaming requests.
+     */
+    session_id?: string;
+    /**
+     * Duration of the generated video as reported by the Agents API for Talks (V2) and Clips (V3)
+     * agents. `0` when the call produced no discrete video — on Expressive (V4) agents, and in a
+     * text-only chat mode.
+     */
     duration: number;
+    /**
+     * Id of the generated video.
+     *
+     * Use it to correlate this call with the video the agent then plays, which
+     * {@link AgentManagerCallbacks.onVideoStateChange | onVideoStateChange} reports the start and
+     * end of, and which {@link AgentManager.interrupt | interrupt()} cancels. Empty when the call
+     * produced no discrete video — on Expressive (V4) agents, and in a text-only chat mode.
+     */
     video_id: string;
 }
 export {};