Authorization: Bearer <API_KEY>
query
field is used to find semantically similar content, while optional keywords
can filter results. Use keyword_operator
to control how multiple keywords are combined, and max_results
to limit the number of returned items.
Field | Type | Required | Description |
---|---|---|---|
query | string | ✅ | The semantic search text |
keywords | string[] | ❌ | Keywords to filter results |
keyword_operator | ”and” | “or” | ❌ | Default: “and” |
max_results | number (1-100) | ❌ | Defaults to environment variable or 10 |
Authorization: Bearer <API_KEY>
Field | Type | Required | Description |
---|---|---|---|
similarity_query.query | string | ✅ | Text for semantic matching |
similarity_query.weight | number (0–1) | ✅ | Weight to apply to vector score |
text_query.query | string | ✅ | Text for full-text keyword matching |
text_query.weight | number (0–1) | ✅ | Weight to apply to text score |
keywords | string[] | ❌ | Optional filter keywords |
keyword_operator | ”and” | “or” | ❌ | Default: “and” |
max_results | number (1–100) | ❌ | Defaults to env value or 10 |
Use Case | Similarity Search | Hybrid Search |
---|---|---|
Quick semantic matching without keywords | ✅ | — |
Blend semantic meaning with keyword search | — | ✅ |
Fine-tune relevance scoring | — | ✅ |
Approximate text matching | ✅ | — |