docs(search): add comprehensive Search API documentation #112
Conversation
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
Implement direct access to Perplexity's real-time web index via Search API, providing raw ranked search results without the generative LLM layer. Core features: - SearchRequest with functional options pattern (WithSearchMaxResults, etc.) - Support for single and multi-query searches - SearchResponse with result items, images, snippets, scores - SearchRequestValidator with comprehensive validation - Complete test coverage for request, response, and validation - Working example demonstrating simple, advanced, and multi-query searches API endpoint: https://api.perplexity.ai/search Pricing: $5 per 1K requests (separate from chat completions)
- Align struct field indentation across multiple files - Fix whitespace alignment in switch case comments - Add missing newlines at end of files - Improve code readability with consistent formatting No functional changes.
Add extensive test coverage including benchmarks, compliance tests, integration tests, and edge case validation. Test additions: - Benchmark tests for request marshaling performance - API compliance tests verifying specification adherence - Integration tests for real API interactions (require PPLX_API_KEY) - Extended validator tests for edge cases (unicode, special chars, long strings) Total: 1,434 lines of new test coverage
Update README and add example documentation covering Search API features, usage patterns, and comparison with chat completions. Changes: - Add Search API section to main README with features and pricing - Include basic, advanced, and multi-query search examples - Add comparison table: Search API vs Chat Completions - Create detailed search-example README with build/run instructions - Document all search options and validation patterns - Add context support examples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docs(search): add comprehensive Search API documentation
Update README and add example documentation covering Search API features,
usage patterns, and comparison with chat completions.
Changes: