Repository navigation
docs(search): document valuableResults in search feedback - #1674
Open
mintlify[bot] wants to merge 1 commit into
Open
mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the new
valuableResultsfield on search feedback, so callers can mark useful results by theirsourcegroup and position instead of only by URL.Search results come back grouped (
data.web,data.images,data.news) and each group is numbered from 1, so the API now takes{ source, position, reason? }entries. Results that are left out count as not useful, and positions past what a group returned are ignored. The OpenAPI spec, the Search Feedback endpoint page and the Search page only mentionedvaluableSources.Based on Collect search feedback on results across all sources, which added the field to the API, and Add --valuable-results to search feedback, which brought it to the CLI.
Needs a human look: the endpoint page says to use
valuableSourcesfor useful URLs, including ones that weren't in the results. Please confirm that matches how you want the two fields used.