Fix /findSimilar curl example: wrap text in contents object #4
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.
Summary
Fixes the curl example for the
/findSimilarendpoint. Thetextparameter must be wrapped in acontentsobject for the raw API - using"text": trueat the top level is silently ignored.The Python and JS SDK examples are correct as-is because the SDKs handle this transformation internally.
Review & Testing Checklist for Human
contents: {text: true}actually returns text content in results"text": trueat top level was indeed being ignoredNotes
Part of a docs audit finding behavior mismatches between documentation and actual API behavior.
Link to Devin run: https://app.devin.ai/sessions/616457e78aea475481e0607e4f176b40
Requested by: Michael Fine (@mfine15), PRs requested by Ishan Goswami