Skip to content

add rerank configs in controlplane #1158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harshmaru7 merged 2 commits into from
Apr 23, 2026
+28 −2
Merged

add rerank configs in controlplane #1158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3da1c48
add rerank configs in controlplane
snegi-do Apr 21, 2026
9e18c42
Merge branch 'main' into add-rerank-configs
harshmaru7 Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions specification/resources/gen-ai/definitions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1602,6 +1602,8 @@ apiCreateKnowledgeBaseInputPublic:
description: The datacenter region to deploy the knowledge base in.
example: '"tor1"'
type: string
reranking_config:
$ref: '#/apiRerankingConfiguration'
tags:
description: Tags to organize your knowledge base.
example:
Expand Down Expand Up @@ -3267,6 +3269,8 @@ apiKnowledgeBase:
description: Region code
example: example string
type: string
reranking_config:
$ref: '#/apiRerankingConfiguration'
tags:
description: Tags to organize related resources
example:
Expand Down Expand Up @@ -4585,6 +4589,18 @@ apiReleaseStatus:
- RELEASE_STATUS_BUILDING
example: RELEASE_STATUS_UNKNOWN
type: string
apiRerankingConfiguration:
description: Configuration for cross-encoder reranking during retrieval.
properties:
Copy link
Copy Markdown
Contributor

@harshmaru7 harshmaru7 Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to validate - there are no required fields?

Copy link
Copy Markdown
Contributor Author

@snegi-do snegi-do Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no

enabled:
description: Whether reranking is enabled for retrieval
example: true
type: boolean
model:
description: Reranker model internal name
Copy link
Copy Markdown
Contributor

@harshmaru7 harshmaru7 Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we re-phrase this ? not sure what internal refers to here

Copy link
Copy Markdown
Contributor Author

@snegi-do snegi-do Apr 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we require the internal name of model. Users can view the internal names of all models in the model catalog UI page. Model catalog shows internal name of models. I've also given example of internal name (currently we only have one reranker model)

example: '"bge-reranker-v2-m3"'
type: string
type: object
apiResourceUsage:
description: Resource Usage Description
properties:
Expand Down Expand Up @@ -5296,6 +5312,8 @@ apiUpdateKnowledgeBaseInputPublic:
to
example: '"12345678-1234-1234-1234-123456789012"'
type: string
reranking_config:
$ref: '#/apiRerankingConfiguration'
tags:
description: Tags to organize your knowledge base.
example:
Expand Down
6 changes: 5 additions & 1 deletion specification/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ source: |-
},
],
"region": "tor1",
"vpc_uuid": "f7176e0b-8c5e-4e32-948e-79327e56225a"
"vpc_uuid": "f7176e0b-8c5e-4e32-948e-79327e56225a",
"reranking_config": {
"enabled": true,
"model": "bge-reranker-v2-m3"
}
}'
6 changes: 5 additions & 1 deletion specification/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,9 @@ source: |-
"https://api.digitalocean.com/v2/gen-ai/knowledge_bases/e51dba65-cf7a-11ef-bf8f-4e013e2ddde4" \
-d '{
"uuid": "e51dba65-cf7a-11ef-bf8f-4e013e2ddde4",
"name": "kb-api-rename"
"name": "kb-api-rename",
"reranking_config": {
"enabled": true,
"model": "bge-reranker-v2-m3"
}
}'
Loading