Skip to main content

CvdsIngestResponse

Per-candidate ingest result plus a roll-up summary.

results object[]required
  • Array [
  • external_idstringrequired
    Example: cand-001
    statusstringrequired
    • accepted — a new candidate was written.
    • updated — an existing candidate's content changed and was re-embedded.
    • unchanged — the content was identical to what's already stored (no re-embed).

    Possible values: [accepted, updated, unchanged]

    embedding_statusstringrequired
    • pending — embedding is in progress (poll the single-candidate endpoint for the final state).
    • embedded — the candidate is searchable.
    • failed — embedding failed; the candidate won't be returned by a search until re-ingested successfully.

    Possible values: [pending, embedded, failed]

  • ]
  • summary objectrequired

    Roll-up counts across the batch.

    acceptedintegerrequired

    New candidates written.

    updatedintegerrequired

    Existing candidates whose content changed.

    unchangedintegerrequired

    Candidates whose content was identical (no re-embed).

    failedintegerrequired

    Candidates whose embedding failed.

    CvdsIngestResponse
    {
    "results": [
    {
    "external_id": "cand-001",
    "status": "accepted",
    "embedding_status": "pending"
    }
    ],
    "summary": {
    "accepted": 0,
    "updated": 0,
    "unchanged": 0,
    "failed": 0
    }
    }