VocalDocscontracts 1.65.0

Delete a corpus query

DELETE /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}

PropertyValue
Operationdelete_knowledge_eval_query
GroupKnowledge bases
Scopeknowledge:write
Route classcontrol
IdempotencyNo Idempotency-Key
AuditAudited knowledge.eval_query.delete (mutation)
Released in1.53.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Deletes a corpus query at the revision If-Match names (1.53.0); the results of earlier Evaluations keep its id.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X DELETE "$VOCAL_API/v1/knowledge-bases/kb_.../eval-queries/kq_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

Parameters

NameInTypeRequiredDescription
knowledge_base_idpathKnowledgeBaseIdyesThe id of a Knowledge base: kb_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
eval_query_idpathKnowledgeEvalQueryIdyesThe id of a query of the retrieval-quality corpus of a Knowledge base: kq_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
if-matchheaderstringyesThe revision the change was made against, quoted as the ETag returns it, or * to overwrite.

Responses

StatusContent typeShapeError codes
200application/jsonKnowledgeEvalQueryDeletion
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden, org_suspended
404application/jsonErrorEnvelopenot_found
409application/jsonErrorEnvelopeknowledge_base_archived
412application/jsonErrorEnveloperevision_mismatch
428application/jsonErrorEnvelopeprecondition_required
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is KnowledgeEvalQueryDeletion.

FieldTypeRequiredDescription
deleted_atTimestampyes
idKnowledgeEvalQueryIdyes
object"knowledge_eval_query_deletion"yes