Commit b35d971
authored
docs(search): add comprehensive Search API documentation (#112)
* feat(search): add Perplexity Search API support
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)
* style: improve code formatting and alignment
- 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.
* test(search): add comprehensive test suite for Search API
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
* 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:
- 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 examples1 parent efc2d9f commit b35d971
File tree
29 files changed
+3174
-111
lines changed- cmd
- async-completion
- basic-completion
- image-search
- search-example
- streaming-sse
- structured-output
29 files changed
+3174
-111
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
18 | 21 | | |
19 | 22 | | |
20 | 23 | | |
| |||
70 | 73 | | |
71 | 74 | | |
72 | 75 | | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
73 | 191 | | |
74 | 192 | | |
75 | | - | |
| 193 | + | |
76 | 194 | | |
77 | 195 | | |
78 | 196 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | | - | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| |||
247 | 247 | | |
248 | 248 | | |
249 | 249 | | |
250 | | - | |
| 250 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
| 101 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | | - | |
| 78 | + | |
0 commit comments