Semantic Search | PrivateGPT

{
  "content": [
    {
      "sources": [
        {
          "content_type": "text/markdown",
          "document": {
            "artifact": "0196ee69-666a-7bcd-800b-b01fa9b2f24c",
            "doc_metadata": {
              "file_name": "dense_x_retrieval.pdf"
            },
            "object": "ingest.document"
          },
          "id": "d3ab07fe-b7ab-4fda-8524-1cb41b01200a",
          "metadata": {
            "page": 13,
            "shorter_id": "GONG"
          },
          "next_texts": [],
          "object": "context.chunk",
          "previous_texts": [],
          "score": 0.83,
          "text": "Wenhao Yu et al. 2023. Chain-ofnote: Enhancing robustness in retrieval-augmented LMs."
        }
      ],
      "type": "source"
    },
    {
      "text": "**Context Information**:\nCitation identifier [GONG]\n---\nContent:\nWenhao Yu, Hongming Zhang... Chain-ofnote: Enhancing robustness in retrieval-augmented language models.",
      "type": "text"
    }
  ],
  "is_error": false
}

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

Request

Request body for semantic search. Includes the query, optional filters, and response formatting preferences.

querystringRequired

The natural language query to search for relevant content.

context_filterobjectRequired

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

formatenumOptionalDefaults to default

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

Response

Semantic search completed successfully.

contentlist of objects

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

is_errorbooleanDefaults to false

True if the tool encountered an error during execution.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

$	curl -X POST /v1/tools/semantic-search \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "What were the Q4 revenue trends?",
>	"context_filter": {}
>	}'