Skip to main content

KnowledgeBaseCopyReport

The plan (dry_run) or the result of a knowledge base copy.

dry_runDry Runrequired

Whether nothing was written.

source_agent_idSource Agent Idrequired

Agent the documents came from.

target_agent_idTarget Agent Idrequired

Agent that received them.

directories object[]

One entry per selected source directory.

  • Array [
    • source_directory_idSource Directory Idrequired

    Directory on the source agent.

    nameNamerequired

    Directory name; the merge key.

    actionActionrequired

    reuse - an existing target directory with this name receives the documents; create - a new one is created.

    Possible values: [create, reuse]

    target_directory_id object

    The target directory; null in a dry run for directories that would be created.

    anyOf
    integer
  • ]
    • documents object[]

    One entry per source document in the selected directories.

  • Array [
    • source_document_idSource Document Idrequired

    Document on the source agent.

    titleTitlerequired

    Document title.

    source_directory_idSource Directory Idrequired

    Its directory on the source agent.

    actionActionrequired

    copy - cloned; skip_duplicate - the target already holds the same source hash or the same title in the same directory (target_document_id points at it); skip_not_ready - ingestion has not finished or failed; skip_no_source - no source artifact in object storage; skip_hitl_answers - the manager-approved answers document, excluded unless include_hitl_answers.

    Possible values: [copy, skip_duplicate, skip_not_ready, skip_no_source, skip_hitl_answers]

    target_document_id object

    The clone, or the existing duplicate; null in a dry run.

    anyOf
    integer
  • ]
    • copiedCopied

    Number of documents cloned.

    Default value: 0
    skippedSkipped

    Number of documents skipped, for any reason.

    Default value: 0
    KnowledgeBaseCopyReport
    {
      "dry_run": true,
      "source_agent_id": 0,
      "target_agent_id": 0,
      "directories": [
        {
          "source_directory_id": 0,
          "name": "string",
          "action": "create",
          "target_directory_id": 0
        }
      ],
      "documents": [
        {
          "source_document_id": 0,
          "title": "string",
          "source_directory_id": 0,
          "action": "copy",
          "target_document_id": 0
        }
      ],
      "copied": 0,
      "skipped": 0
    }