-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Reranking documentation #25867
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.
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
base: production
Are you sure you want to change the base?
Reranking documentation #25867
Conversation
This PR requires additional review attention because it affects the following areas: PartialsThis PR updates partial files, which are pieces of content used across multiple files in our Render component.
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
"enabled": true, | ||
"model": "@cf/baai/bge-reranker-base" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These attributes don't go in this object. They are exposed through a new object, reranking
.
"enabled": true | ||
"model": "@cf/baai/bge-reranker-base" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above
enabled: true, | ||
model: "@cf/baai/bge-reranker-base" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above
enabled: true, | ||
model: "@cf/baai/bge-reranker-base" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above
- `enabled` <Type text="boolean" /> <MetaInfo text="optional" /> | ||
- Enables or disables reranking, which reorders retrieved results based on semantic relevance using a reranking model. Defaults to `false`. | ||
|
||
- `model` <Type text="string" /> <MetaInfo text="optional" /> | ||
- The reranking model to use when reranking is enabled. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above, these should be placed under a new object called reranking
.
- `enabled` <Type text="boolean" /> <MetaInfo text="optional" /> | ||
- Enables or disables reranking, which reorders retrieved results based on semantic relevance using a reranking model. Defaults to `false`. | ||
|
||
- `model` <Type text="string" /> <MetaInfo text="optional" /> | ||
- The reranking model to use when reranking is enabled. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above
|
||
### Configure via API | ||
|
||
You can also configure via the API. When you make a `/search` or `/ai-search` request using the [Workers Binding](/ai-search/usage/workers-binding/) or [REST API](/ai-search/usage/rest-api/), you can: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: it sounds a bit weird saying also
here when this is the first example.
Summary
Screenshots (optional)
Documentation checklist