Skip to main content
PATCH
/
api
/
kb
/
collections
/
{collection}
/
rerank-model
Set Collection Rerank Model
curl --request PATCH \
  --url https://api.example.com/api/kb/collections/{collection}/rerank-model \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rerank_model_id": "<string>"
}
'
{
  "status": "<string>",
  "collection": "<string>",
  "message": "<string>",
  "warnings": [
    "<string>"
  ],
  "affected_documents": [
    {
      "doc_id": "<string>",
      "message": "<string>"
    }
  ],
  "deleted_counts": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collection
string
required

Body

application/json
rerank_model_id
string | null

Rerank model ID registered in the model hub. Pass null or an empty string to clear the binding (search will no longer rerank for this collection).

Response

Successful Response

Response payload for collection-level management operations.

status
string
required

Operation status: success|partial_success|error

collection
string
required

Collection identifier affected by the operation

message
string
required

Human-readable summary of the collection operation

warnings
string[]

Non-fatal issues encountered while processing the collection

affected_documents
CollectionOperationDetail · object[]

Subset of documents impacted by the collection operation

deleted_counts
Deleted Counts · object

Aggregated deletion counts per table when applicable