Semantic search contexts

Vector + BM25 hybrid search over contexts. Returns relevance scores and highlights.

GET /contexts/semantic-search

Semantic search contexts

cURL

curl --request GET \
  --url https://apigcp.trynia.ai/v2/contexts/semantic-search \
  --header 'Authorization: Bearer <token>'

200

{
  "search_query": "<string>",
  "search_metadata": {
    "search_type": "semantic",
    "total_results": 0,
    "vector_matches": 0,
    "mongodb_matches": 0
  },
  "suggestions": {
    "related_tags": [
      "<string>"
    ],
    "workspaces": [
      "<string>"
    ],
    "tips": [
      "<string>"
    ]
  },
  "results": [
    {}
  ]
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Query Parameters

q · string · required

Search query

Minimum string length: 1

limit · integer · default: 20

Number of contexts to return

Required range: 1 <= x <= 100

include_highlights · boolean · default: true

Include match highlights

workspace_filter · string | null

Filter by specific workspace name

Response

200

application/json

Successful Response

Response for semantic search in contexts.

search_query · string · required

The search query used

search_metadata · ContextSemanticSearchMetadata · object · required

Search metadata

Show child attributes

suggestions · ContextSemanticSearchSuggestions · object · required

Search suggestions

Show child attributes

results · Results · object[]

Search results with scores