Query Observations

Query observations using semantic search.

Performs vector similarity search on observations to find semantically relevant results. Observer and observed are required for semantic search and must be provided in filters.

POST /v2/workspaces/{workspace_id}/observations/query

Query Observations

cURL

curl --request POST \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/observations/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "top_k": 10,
  "distance": 0.5,
  "filters": {}
}
'

200

[
  {
    "id": "<string>",
    "content": "<string>",
    "observer_id": "<string>",
    "observed_id": "<string>",
    "session_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id · string · required

ID of the workspace

Body

application/json

Semantic search parameters for observations

query · string · required

Semantic search query

top_k · integer · default: 10

Number of results to return

Required range: 1 <= x <= 100

distance · number | null

Maximum cosine distance threshold for results

Required range: 0 <= x <= 1

filters · Filters · object

Additional filters to apply

Response

200

application/json

Successful Response

id · string · required

content · string · required

observer_id · string · required

The peer who made the observation

observed_id · string · required

The peer being observed

session_id · string · required

created_at · string<date-time> · required