Semantic Search | PrivateGPT

Run a semantic search using natural language and contextual filters. Supports citation formatting.

This endpoint expects an object.

querystringRequired

The natural language query to search for relevant content.

context_filterobjectRequired

Filters to narrow the search context (collections, artifacts, metadata).

formatenumOptional

Format of the result content. 'default' returns standard content blocks. 'citations' returns blocks annotated for citation formatting.

Allowed values:

This endpoint returns an object.

contentlist of objects

List of content blocks generated by the tool. Blocks can include plain text, citations, source attributions, or images.

is_errorboolean

True if the tool encountered an error during execution.

401

Unauthorized

422

Unprocessable Entity

$	curl -X POST https://host.com/v1/tools/semantic-search \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "query",
>	"context_filter": {}
>	}'