Skip to the content

Update a corpus query

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

Property	Value
Operation	`update_knowledge_eval_query`
Group	Knowledge bases
Scope	`knowledge:write`
Route class	`control`
Idempotency	No `Idempotency-Key`
Audit	Audited `knowledge.eval_query.update` (mutation)
Released in	1.53.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Replaces the named fields of a corpus query at the revision If-Match names, checked as a creation is (1.53.0). An Evaluation that ran the earlier revision is stale for a publish.

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 PATCH "$VOCAL_API/v1/knowledge-bases/kb_.../eval-queries/kq_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../eval-queries/kq_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../eval-queries/kq_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`knowledge_base_id`	path	KnowledgeBaseId	yes	The id of a Knowledge base: `kb_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`eval_query_id`	path	KnowledgeEvalQueryId	yes	The 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-match`	header	string	yes	The revision the change was made against, quoted as the ETag returns it, or `*` to overwrite.

Request body

Content type application/json, required: KnowledgeEvalQueryUpdateRequest.

Field	Type	Required	Description
`expect_empty`	boolean	no	True when no passage should score at or above `min_score` for the query.
`filter`	KnowledgeFilterInput or null	no
`query`	string	no
`relevant_documents`	array of KnowledgeDocumentId	no	The Documents that answer the query; empty when `expect_empty`.
`tags`	array of KnowledgeEvalQueryTag	no	snake_case labels that group the queries, such as `lab_visits`.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	KnowledgeEvalQuery
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`knowledge_base_archived`
`412`	`application/json`	ErrorEnvelope	`revision_mismatch`
`422`	`application/json`	ErrorEnvelope	`validation_failed`
`428`	`application/json`	ErrorEnvelope	`precondition_required`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is KnowledgeEvalQuery.

Field	Type	Required	Description
`created_at`	Timestamp	yes
`expect_empty`	boolean	yes	True when no passage should score at or above `min_score` for the query.
`filter`	KnowledgeFilter or null	yes	The filter the query is run under, as a binding would fix it; null for none.
`id`	KnowledgeEvalQueryId	yes
`knowledge_base_id`	KnowledgeBaseId	yes
`object`	`"knowledge_eval_query"`	yes
`query`	string or null	yes	The question as a caller would ask it: the content class `text`, null unless the read names `include=text`, and null in the answer of a write.
`relevant_documents`	array of KnowledgeDocumentId	yes	The Documents that answer the query; empty when `expect_empty`.
`revision`	integer	yes	Counts writes; returned as the ETag and required in If-Match.
`tags`	array of KnowledgeEvalQueryTag	yes	snake_case labels that group the queries, such as `lab_visits`.
`updated_at`	Timestamp	yes