Update a reranker
Updates an existing reranker configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated.
IMMUTABLE FIELDS: providerType and ownerId cannot be changed after creation. SUPPORTED_MODALITIES
UPDATE: If the array contains ≥1 elements, it replaces the stored set; if empty or omitted, no change occurs. Returns ALREADY_EXISTS if update would create duplicate with same {ownerId, providerType, endpointUrl, apiPath, modelIdentifier, credentialsFingerprint} after URL canonicalization (HTTP 409 Conflict / ALREADY_EXISTS). Requires UPDATE_RERANKER_OWN permission for rerankers you own (or UPDATE_RERANKER_ANY for admin users). This operation is idempotent.
In: header
Path Parameters
The unique identifier of the reranker to update
Updated reranker configuration details
Empty Object
User-facing name of the reranker
1 <= length <= 255Description of the reranker
API endpoint URL
API path for reranking request
Model identifier
Supported content modalities
Structured credential payload describing how to authenticate with the provider. Omit to keep existing credentials.
Replace all existing labels with these (mutually exclusive with mergeLabels)
properties <= 20Empty Object
Merge these labels with existing ones (mutually exclusive with replaceLabels)
properties <= 20Empty Object
Version information
Monitoring endpoint URL
Response Body
curl -X PUT "http://localhost:8080/v1/rerankers/550e8400-e29b-41d4-a716-446655440000" \ -H "Content-Type: application/json" \ -d '{ "displayName": "Updated Production BGE Reranker", "description": "Updated BAAI BGE cross-encoder reranker with enhanced configuration for production use", "endpointUrl": "http://bge.reranker.goodmem.ai:8010", "apiPath": "/rerank", "modelIdentifier": "BAAI/bge-reranker-large", "supportedModalities": [ "TEXT" ], "credentials": { "kind": "CREDENTIAL_KIND_API_KEY", "apiKey": { "inlineSecret": "updated-api-key-here" } }, "version": "2.1.0", "monitoringEndpoint": "https://monitoring.company.com/rerankers/status", "replaceLabels": { "environment": "production", "team": "search-platform", "cost-center": "ml-infrastructure" } }'{
"rerankerId": "550e8400-e29b-41d4-a716-446655440000",
"displayName": "BGE Cross-Encoder Reranker",
"description": "BAAI BGE reranker for cross-encoder semantic ranking",
"providerType": "TEI",
"endpointUrl": "http://bge.reranker.goodmem.ai:8010",
"apiPath": "/rerank",
"modelIdentifier": "BAAI/bge-reranker-base",
"supportedModalities": [
"TEXT"
],
"labels": "{\"environment\": \"production\", \"team\": \"search\"}",
"version": "1.0.0",
"monitoringEndpoint": "https://monitoring.example.com/rerankers/status",
"ownerId": "550e8400-e29b-41d4-a716-446655440000",
"createdAt": "1617293472000",
"updatedAt": "1617293472000",
"createdById": "550e8400-e29b-41d4-a716-446655440000",
"updatedById": "550e8400-e29b-41d4-a716-446655440000"
}