import os
from qaip import Qaip
client = Qaip(
api_key=os.environ.get("QAIP_API_KEY"), # This is the default and can be omitted
)
response = client.search(
query="machine learning and artificial intelligence",
)
print(response.created)curl --request POST \
--url https://developer.qaip.com/api/v1/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "machine learning and artificial intelligence",
"tags": [
"<string>"
],
"tag_ids": [
"<string>"
],
"tag_filter_logic": "OR",
"source_types": [],
"file_types": [],
"date_from": 1735639200,
"date_to": 1735639200,
"domains": [
"example.com",
"blog.example.com"
],
"metadata": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"source_metadata": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"chunk_metadata": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"metadata_filter": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"limit": 10,
"offset": 0,
"use_postfilter": false,
"authz_policy": "external-chatbot",
"principal_id": "user-123"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: 'machine learning and artificial intelligence',
tags: ['<string>'],
tag_ids: ['<string>'],
tag_filter_logic: 'OR',
source_types: [],
file_types: [],
date_from: 1735639200,
date_to: 1735639200,
domains: ['example.com', 'blog.example.com'],
metadata: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
source_metadata: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
chunk_metadata: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
metadata_filter: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
limit: 10,
offset: 0,
use_postfilter: false,
authz_policy: 'external-chatbot',
principal_id: 'user-123'
})
};
fetch('https://developer.qaip.com/api/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.qaip.com/api/v1/search",
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' => 'machine learning and artificial intelligence',
'tags' => [
'<string>'
],
'tag_ids' => [
'<string>'
],
'tag_filter_logic' => 'OR',
'source_types' => [
],
'file_types' => [
],
'date_from' => 1735639200,
'date_to' => 1735639200,
'domains' => [
'example.com',
'blog.example.com'
],
'metadata' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'source_metadata' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'chunk_metadata' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'metadata_filter' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'limit' => 10,
'offset' => 0,
'use_postfilter' => false,
'authz_policy' => 'external-chatbot',
'principal_id' => 'user-123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "https://developer.qaip.com/api/v1/search"
payload := strings.NewReader("{\n \"query\": \"machine learning and artificial intelligence\",\n \"tags\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"tag_filter_logic\": \"OR\",\n \"source_types\": [],\n \"file_types\": [],\n \"date_from\": 1735639200,\n \"date_to\": 1735639200,\n \"domains\": [\n \"example.com\",\n \"blog.example.com\"\n ],\n \"metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"source_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"chunk_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"metadata_filter\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"use_postfilter\": false,\n \"authz_policy\": \"external-chatbot\",\n \"principal_id\": \"user-123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("https://developer.qaip.com/api/v1/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"machine learning and artificial intelligence\",\n \"tags\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"tag_filter_logic\": \"OR\",\n \"source_types\": [],\n \"file_types\": [],\n \"date_from\": 1735639200,\n \"date_to\": 1735639200,\n \"domains\": [\n \"example.com\",\n \"blog.example.com\"\n ],\n \"metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"source_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"chunk_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"metadata_filter\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"use_postfilter\": false,\n \"authz_policy\": \"external-chatbot\",\n \"principal_id\": \"user-123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.qaip.com/api/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"machine learning and artificial intelligence\",\n \"tags\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"tag_filter_logic\": \"OR\",\n \"source_types\": [],\n \"file_types\": [],\n \"date_from\": 1735639200,\n \"date_to\": 1735639200,\n \"domains\": [\n \"example.com\",\n \"blog.example.com\"\n ],\n \"metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"source_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"chunk_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"metadata_filter\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"use_postfilter\": false,\n \"authz_policy\": \"external-chatbot\",\n \"principal_id\": \"user-123\"\n}"
response = http.request(request)
puts response.read_body{
"created": 1677649420,
"results": [
{
"id": "<string>",
"text": "<string>",
"url": "<string>",
"title": "<string>",
"timestamp": 123,
"page_number": 0,
"source_id": "<string>",
"keywords": [
"<string>"
]
}
]
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}Search content
Searches through indexed content using query.
Required roles: All, App
import os
from qaip import Qaip
client = Qaip(
api_key=os.environ.get("QAIP_API_KEY"), # This is the default and can be omitted
)
response = client.search(
query="machine learning and artificial intelligence",
)
print(response.created)curl --request POST \
--url https://developer.qaip.com/api/v1/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "machine learning and artificial intelligence",
"tags": [
"<string>"
],
"tag_ids": [
"<string>"
],
"tag_filter_logic": "OR",
"source_types": [],
"file_types": [],
"date_from": 1735639200,
"date_to": 1735639200,
"domains": [
"example.com",
"blog.example.com"
],
"metadata": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"source_metadata": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"chunk_metadata": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"metadata_filter": {
"logic": "OR",
"filters": [
{
"key": "<string>",
"operator": "eq",
"val": "<unknown>",
"min": "<unknown>",
"max": "<unknown>"
}
],
"groups": "<array>"
},
"limit": 10,
"offset": 0,
"use_postfilter": false,
"authz_policy": "external-chatbot",
"principal_id": "user-123"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: 'machine learning and artificial intelligence',
tags: ['<string>'],
tag_ids: ['<string>'],
tag_filter_logic: 'OR',
source_types: [],
file_types: [],
date_from: 1735639200,
date_to: 1735639200,
domains: ['example.com', 'blog.example.com'],
metadata: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
source_metadata: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
chunk_metadata: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
metadata_filter: {
logic: 'OR',
filters: [
{
key: '<string>',
operator: 'eq',
val: '<unknown>',
min: '<unknown>',
max: '<unknown>'
}
],
groups: '<array>'
},
limit: 10,
offset: 0,
use_postfilter: false,
authz_policy: 'external-chatbot',
principal_id: 'user-123'
})
};
fetch('https://developer.qaip.com/api/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.qaip.com/api/v1/search",
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' => 'machine learning and artificial intelligence',
'tags' => [
'<string>'
],
'tag_ids' => [
'<string>'
],
'tag_filter_logic' => 'OR',
'source_types' => [
],
'file_types' => [
],
'date_from' => 1735639200,
'date_to' => 1735639200,
'domains' => [
'example.com',
'blog.example.com'
],
'metadata' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'source_metadata' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'chunk_metadata' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'metadata_filter' => [
'logic' => 'OR',
'filters' => [
[
'key' => '<string>',
'operator' => 'eq',
'val' => '<unknown>',
'min' => '<unknown>',
'max' => '<unknown>'
]
],
'groups' => '<array>'
],
'limit' => 10,
'offset' => 0,
'use_postfilter' => false,
'authz_policy' => 'external-chatbot',
'principal_id' => 'user-123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "https://developer.qaip.com/api/v1/search"
payload := strings.NewReader("{\n \"query\": \"machine learning and artificial intelligence\",\n \"tags\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"tag_filter_logic\": \"OR\",\n \"source_types\": [],\n \"file_types\": [],\n \"date_from\": 1735639200,\n \"date_to\": 1735639200,\n \"domains\": [\n \"example.com\",\n \"blog.example.com\"\n ],\n \"metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"source_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"chunk_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"metadata_filter\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"use_postfilter\": false,\n \"authz_policy\": \"external-chatbot\",\n \"principal_id\": \"user-123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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("https://developer.qaip.com/api/v1/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"machine learning and artificial intelligence\",\n \"tags\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"tag_filter_logic\": \"OR\",\n \"source_types\": [],\n \"file_types\": [],\n \"date_from\": 1735639200,\n \"date_to\": 1735639200,\n \"domains\": [\n \"example.com\",\n \"blog.example.com\"\n ],\n \"metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"source_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"chunk_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"metadata_filter\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"use_postfilter\": false,\n \"authz_policy\": \"external-chatbot\",\n \"principal_id\": \"user-123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.qaip.com/api/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"machine learning and artificial intelligence\",\n \"tags\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"tag_filter_logic\": \"OR\",\n \"source_types\": [],\n \"file_types\": [],\n \"date_from\": 1735639200,\n \"date_to\": 1735639200,\n \"domains\": [\n \"example.com\",\n \"blog.example.com\"\n ],\n \"metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"source_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"chunk_metadata\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"metadata_filter\": {\n \"logic\": \"OR\",\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"operator\": \"eq\",\n \"val\": \"<unknown>\",\n \"min\": \"<unknown>\",\n \"max\": \"<unknown>\"\n }\n ],\n \"groups\": \"<array>\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"use_postfilter\": false,\n \"authz_policy\": \"external-chatbot\",\n \"principal_id\": \"user-123\"\n}"
response = http.request(request)
puts response.read_body{
"created": 1677649420,
"results": [
{
"id": "<string>",
"text": "<string>",
"url": "<string>",
"title": "<string>",
"timestamp": 123,
"page_number": 0,
"source_id": "<string>",
"keywords": [
"<string>"
]
}
]
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>"
}
}Authorizations
API key for authentication
Body
Search query string
"machine learning and artificial intelligence"
target tag names to be obtained
target tag IDs to be obtained
Logical operator for combining filter conditions
AND, OR The type of the source
crawl, local_file, google_drive, github, notion The type of the source file
html, pdf, ppt, pptx, pptm, doc, docx, docm, xls, xlsx, xlsm, md, txt, jsonl, png, jpg, webp, heic, heif, wav, mp3, aiff, aac, m4a, ogg, flac, mp4, mpg, mov, avi, flv, webm, wmv, 3gp, notion_page Start date for content search (Unix timestamp in seconds)
x >= 17356392001735639200
End date for content search (Unix timestamp in seconds)
x >= 17356392001735639200
Array of domains to search within (supports partial matching)
["example.com", "blog.example.com"]
(reserved for future use) Filter group with nested structure. Supports combining filters with AND/OR logic.
Show child attributes
Show child attributes
Filter by individual source/file metadata from source_metadatas table
Show child attributes
Show child attributes
Filter by chunk-level metadata from chunk_metadatas table
Show child attributes
Show child attributes
Filter by declared metadata columns (see /metadata_columns) pushed down directly to LanceDB (no PostgreSQL round-trip). Targets string/integer typed columns. Keys must be declared via /metadata_columns or the request is rejected (400).
Show child attributes
Show child attributes
Maximum number of results to return
1 <= x <= 10010
Number of results to skip
x >= 00
Whether to bypass LanceDB prefilter and apply WHERE after the
vector search (IVF_PQ) returns top-K. Significantly faster for
broad filters that cover most of the table, but may return
fewer than limit results when the hit rate is low.
(reserved for future use) Name of the registered authz policy to evaluate for this request. Defaults to the reserved "default" policy when omitted. Ignored when authz is disabled. An unknown or malformed name returns 400.
^[a-z][a-z0-9_-]{0,63}$"external-chatbot"
Identifier of the end-user (principal) on whose behalf this request is made. Used to look up the principal's authz subject attributes for policy evaluation. When omitted, subject attributes are empty (most restrictive). Ignored when authz is disabled.
256"user-123"

