Query Observations
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": {}
}
'import requests
url = "http://localhost:8000/v2/workspaces/{workspace_id}/observations/query"
payload = {
"query": "<string>",
"top_k": 10,
"distance": 0.5,
"filters": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', top_k: 10, distance: 0.5, filters: {}})
};
fetch('http://localhost:8000/v2/workspaces/{workspace_id}/observations/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/observations/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'top_k' => 10,
'distance' => 0.5,
'filters' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/v2/workspaces/{workspace_id}/observations/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"top_k\": 10,\n \"distance\": 0.5,\n \"filters\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/v2/workspaces/{workspace_id}/observations/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"top_k\": 10,\n \"distance\": 0.5,\n \"filters\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/observations/query")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"top_k\": 10,\n \"distance\": 0.5,\n \"filters\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"content": "<string>",
"observer_id": "<string>",
"observed_id": "<string>",
"session_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}observations
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 --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": {}
}
'import requests
url = "http://localhost:8000/v2/workspaces/{workspace_id}/observations/query"
payload = {
"query": "<string>",
"top_k": 10,
"distance": 0.5,
"filters": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', top_k: 10, distance: 0.5, filters: {}})
};
fetch('http://localhost:8000/v2/workspaces/{workspace_id}/observations/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/observations/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'top_k' => 10,
'distance' => 0.5,
'filters' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/v2/workspaces/{workspace_id}/observations/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"top_k\": 10,\n \"distance\": 0.5,\n \"filters\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/v2/workspaces/{workspace_id}/observations/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"top_k\": 10,\n \"distance\": 0.5,\n \"filters\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/observations/query")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"top_k\": 10,\n \"distance\": 0.5,\n \"filters\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"content": "<string>",
"observer_id": "<string>",
"observed_id": "<string>",
"session_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the workspace
Body
application/json
Semantic search parameters for observations
Was this page helpful?
⌘I