D-ID Client SDK - v3.0.0-0
    Preparing search index...

    Interface RetrievalMetadata

    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 matches, so a UI can show the sources behind a reply.

    interface RetrievalMetadata {
        data: string;
        document_id: string;
        id: string;
        knowledge_id: string;
        source_url: string;
        title: string;
    }
    Index
    data: string

    The matched passage itself, as stored in the knowledge base.

    document_id: string

    Id of the source document. Sent back with a rating as the first half of a Rating.matches pair.

    id: string

    Id of this match. Sent back with a rating as the second half of a Rating.matches pair.

    knowledge_id: string

    Id of the knowledge base the document belongs to — the agent's Agent.knowledge.

    source_url: string

    URL of the original source, for linking the citation out of the chat.

    title: string

    Title of the document the passage comes from.