Handle Search Request
curl --request POST \
--url https://staging.hymalaia.app/api/query/document-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"retrieval_options": {
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"run_search": "auto",
"real_time": true,
"filters": {
"source_type": [],
"document_set": [
"<string>"
],
"time_cutoff": "2023-11-07T05:31:56Z",
"tags": [
{
"tag_key": "<string>",
"tag_value": "<string>"
}
]
},
"enable_auto_detect_filters": true,
"offset": 123,
"limit": 123,
"dedupe_docs": false
},
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"recency_bias_multiplier": 1,
"rerank_settings": {
"rerank_model_name": "<string>",
"rerank_api_url": "<string>",
"num_rerank": 123,
"rerank_api_key": "<string>",
"disable_rerank_for_streaming": false
}
}
'import requests
url = "https://staging.hymalaia.app/api/query/document-search"
payload = {
"message": "<string>",
"retrieval_options": {
"chunks_above": 123,
"chunks_below": 123,
"full_doc": False,
"run_search": "auto",
"real_time": True,
"filters": {
"source_type": [],
"document_set": ["<string>"],
"time_cutoff": "2023-11-07T05:31:56Z",
"tags": [
{
"tag_key": "<string>",
"tag_value": "<string>"
}
]
},
"enable_auto_detect_filters": True,
"offset": 123,
"limit": 123,
"dedupe_docs": False
},
"chunks_above": 123,
"chunks_below": 123,
"full_doc": False,
"recency_bias_multiplier": 1,
"rerank_settings": {
"rerank_model_name": "<string>",
"rerank_api_url": "<string>",
"num_rerank": 123,
"rerank_api_key": "<string>",
"disable_rerank_for_streaming": False
}
}
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({
message: '<string>',
retrieval_options: {
chunks_above: 123,
chunks_below: 123,
full_doc: false,
run_search: 'auto',
real_time: true,
filters: {
source_type: [],
document_set: ['<string>'],
time_cutoff: '2023-11-07T05:31:56Z',
tags: [{tag_key: '<string>', tag_value: '<string>'}]
},
enable_auto_detect_filters: true,
offset: 123,
limit: 123,
dedupe_docs: false
},
chunks_above: 123,
chunks_below: 123,
full_doc: false,
recency_bias_multiplier: 1,
rerank_settings: {
rerank_model_name: '<string>',
rerank_api_url: '<string>',
num_rerank: 123,
rerank_api_key: '<string>',
disable_rerank_for_streaming: false
}
})
};
fetch('https://staging.hymalaia.app/api/query/document-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://staging.hymalaia.app/api/query/document-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([
'message' => '<string>',
'retrieval_options' => [
'chunks_above' => 123,
'chunks_below' => 123,
'full_doc' => false,
'run_search' => 'auto',
'real_time' => true,
'filters' => [
'source_type' => [
],
'document_set' => [
'<string>'
],
'time_cutoff' => '2023-11-07T05:31:56Z',
'tags' => [
[
'tag_key' => '<string>',
'tag_value' => '<string>'
]
]
],
'enable_auto_detect_filters' => true,
'offset' => 123,
'limit' => 123,
'dedupe_docs' => false
],
'chunks_above' => 123,
'chunks_below' => 123,
'full_doc' => false,
'recency_bias_multiplier' => 1,
'rerank_settings' => [
'rerank_model_name' => '<string>',
'rerank_api_url' => '<string>',
'num_rerank' => 123,
'rerank_api_key' => '<string>',
'disable_rerank_for_streaming' => false
]
]),
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 := "https://staging.hymalaia.app/api/query/document-search"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"retrieval_options\": {\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"run_search\": \"auto\",\n \"real_time\": true,\n \"filters\": {\n \"source_type\": [],\n \"document_set\": [\n \"<string>\"\n ],\n \"time_cutoff\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\"\n }\n ]\n },\n \"enable_auto_detect_filters\": true,\n \"offset\": 123,\n \"limit\": 123,\n \"dedupe_docs\": false\n },\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"recency_bias_multiplier\": 1,\n \"rerank_settings\": {\n \"rerank_model_name\": \"<string>\",\n \"rerank_api_url\": \"<string>\",\n \"num_rerank\": 123,\n \"rerank_api_key\": \"<string>\",\n \"disable_rerank_for_streaming\": false\n }\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("https://staging.hymalaia.app/api/query/document-search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"retrieval_options\": {\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"run_search\": \"auto\",\n \"real_time\": true,\n \"filters\": {\n \"source_type\": [],\n \"document_set\": [\n \"<string>\"\n ],\n \"time_cutoff\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\"\n }\n ]\n },\n \"enable_auto_detect_filters\": true,\n \"offset\": 123,\n \"limit\": 123,\n \"dedupe_docs\": false\n },\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"recency_bias_multiplier\": 1,\n \"rerank_settings\": {\n \"rerank_model_name\": \"<string>\",\n \"rerank_api_url\": \"<string>\",\n \"num_rerank\": 123,\n \"rerank_api_key\": \"<string>\",\n \"disable_rerank_for_streaming\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.hymalaia.app/api/query/document-search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"retrieval_options\": {\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"run_search\": \"auto\",\n \"real_time\": true,\n \"filters\": {\n \"source_type\": [],\n \"document_set\": [\n \"<string>\"\n ],\n \"time_cutoff\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\"\n }\n ]\n },\n \"enable_auto_detect_filters\": true,\n \"offset\": 123,\n \"limit\": 123,\n \"dedupe_docs\": false\n },\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"recency_bias_multiplier\": 1,\n \"rerank_settings\": {\n \"rerank_model_name\": \"<string>\",\n \"rerank_api_url\": \"<string>\",\n \"num_rerank\": 123,\n \"rerank_api_key\": \"<string>\",\n \"disable_rerank_for_streaming\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"blurb": "<string>",
"boost": 123,
"hidden": true,
"metadata": {},
"match_highlights": [
"<string>"
],
"db_doc_id": 123,
"content": "<string>",
"link": "<string>",
"score": 0,
"is_relevant": true,
"relevance_explanation": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"is_internet": false
}
],
"llm_indices": [
123
],
"pagination": {
"offset": 123,
"limit": 123,
"returned_count": 123,
"has_more": true,
"next_offset": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Search
Handle Search Request
Simple search endpoint, does not create a new message or records in the DB
POST
/
api
/
query
/
document-search
Handle Search Request
curl --request POST \
--url https://staging.hymalaia.app/api/query/document-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"retrieval_options": {
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"run_search": "auto",
"real_time": true,
"filters": {
"source_type": [],
"document_set": [
"<string>"
],
"time_cutoff": "2023-11-07T05:31:56Z",
"tags": [
{
"tag_key": "<string>",
"tag_value": "<string>"
}
]
},
"enable_auto_detect_filters": true,
"offset": 123,
"limit": 123,
"dedupe_docs": false
},
"chunks_above": 123,
"chunks_below": 123,
"full_doc": false,
"recency_bias_multiplier": 1,
"rerank_settings": {
"rerank_model_name": "<string>",
"rerank_api_url": "<string>",
"num_rerank": 123,
"rerank_api_key": "<string>",
"disable_rerank_for_streaming": false
}
}
'import requests
url = "https://staging.hymalaia.app/api/query/document-search"
payload = {
"message": "<string>",
"retrieval_options": {
"chunks_above": 123,
"chunks_below": 123,
"full_doc": False,
"run_search": "auto",
"real_time": True,
"filters": {
"source_type": [],
"document_set": ["<string>"],
"time_cutoff": "2023-11-07T05:31:56Z",
"tags": [
{
"tag_key": "<string>",
"tag_value": "<string>"
}
]
},
"enable_auto_detect_filters": True,
"offset": 123,
"limit": 123,
"dedupe_docs": False
},
"chunks_above": 123,
"chunks_below": 123,
"full_doc": False,
"recency_bias_multiplier": 1,
"rerank_settings": {
"rerank_model_name": "<string>",
"rerank_api_url": "<string>",
"num_rerank": 123,
"rerank_api_key": "<string>",
"disable_rerank_for_streaming": False
}
}
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({
message: '<string>',
retrieval_options: {
chunks_above: 123,
chunks_below: 123,
full_doc: false,
run_search: 'auto',
real_time: true,
filters: {
source_type: [],
document_set: ['<string>'],
time_cutoff: '2023-11-07T05:31:56Z',
tags: [{tag_key: '<string>', tag_value: '<string>'}]
},
enable_auto_detect_filters: true,
offset: 123,
limit: 123,
dedupe_docs: false
},
chunks_above: 123,
chunks_below: 123,
full_doc: false,
recency_bias_multiplier: 1,
rerank_settings: {
rerank_model_name: '<string>',
rerank_api_url: '<string>',
num_rerank: 123,
rerank_api_key: '<string>',
disable_rerank_for_streaming: false
}
})
};
fetch('https://staging.hymalaia.app/api/query/document-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://staging.hymalaia.app/api/query/document-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([
'message' => '<string>',
'retrieval_options' => [
'chunks_above' => 123,
'chunks_below' => 123,
'full_doc' => false,
'run_search' => 'auto',
'real_time' => true,
'filters' => [
'source_type' => [
],
'document_set' => [
'<string>'
],
'time_cutoff' => '2023-11-07T05:31:56Z',
'tags' => [
[
'tag_key' => '<string>',
'tag_value' => '<string>'
]
]
],
'enable_auto_detect_filters' => true,
'offset' => 123,
'limit' => 123,
'dedupe_docs' => false
],
'chunks_above' => 123,
'chunks_below' => 123,
'full_doc' => false,
'recency_bias_multiplier' => 1,
'rerank_settings' => [
'rerank_model_name' => '<string>',
'rerank_api_url' => '<string>',
'num_rerank' => 123,
'rerank_api_key' => '<string>',
'disable_rerank_for_streaming' => false
]
]),
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 := "https://staging.hymalaia.app/api/query/document-search"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"retrieval_options\": {\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"run_search\": \"auto\",\n \"real_time\": true,\n \"filters\": {\n \"source_type\": [],\n \"document_set\": [\n \"<string>\"\n ],\n \"time_cutoff\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\"\n }\n ]\n },\n \"enable_auto_detect_filters\": true,\n \"offset\": 123,\n \"limit\": 123,\n \"dedupe_docs\": false\n },\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"recency_bias_multiplier\": 1,\n \"rerank_settings\": {\n \"rerank_model_name\": \"<string>\",\n \"rerank_api_url\": \"<string>\",\n \"num_rerank\": 123,\n \"rerank_api_key\": \"<string>\",\n \"disable_rerank_for_streaming\": false\n }\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("https://staging.hymalaia.app/api/query/document-search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"retrieval_options\": {\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"run_search\": \"auto\",\n \"real_time\": true,\n \"filters\": {\n \"source_type\": [],\n \"document_set\": [\n \"<string>\"\n ],\n \"time_cutoff\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\"\n }\n ]\n },\n \"enable_auto_detect_filters\": true,\n \"offset\": 123,\n \"limit\": 123,\n \"dedupe_docs\": false\n },\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"recency_bias_multiplier\": 1,\n \"rerank_settings\": {\n \"rerank_model_name\": \"<string>\",\n \"rerank_api_url\": \"<string>\",\n \"num_rerank\": 123,\n \"rerank_api_key\": \"<string>\",\n \"disable_rerank_for_streaming\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.hymalaia.app/api/query/document-search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"retrieval_options\": {\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"run_search\": \"auto\",\n \"real_time\": true,\n \"filters\": {\n \"source_type\": [],\n \"document_set\": [\n \"<string>\"\n ],\n \"time_cutoff\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"tag_key\": \"<string>\",\n \"tag_value\": \"<string>\"\n }\n ]\n },\n \"enable_auto_detect_filters\": true,\n \"offset\": 123,\n \"limit\": 123,\n \"dedupe_docs\": false\n },\n \"chunks_above\": 123,\n \"chunks_below\": 123,\n \"full_doc\": false,\n \"recency_bias_multiplier\": 1,\n \"rerank_settings\": {\n \"rerank_model_name\": \"<string>\",\n \"rerank_api_url\": \"<string>\",\n \"num_rerank\": 123,\n \"rerank_api_key\": \"<string>\",\n \"disable_rerank_for_streaming\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"blurb": "<string>",
"boost": 123,
"hidden": true,
"metadata": {},
"match_highlights": [
"<string>"
],
"db_doc_id": 123,
"content": "<string>",
"link": "<string>",
"score": 0,
"is_relevant": true,
"relevance_explanation": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"is_internet": false
}
],
"llm_indices": [
123
],
"pagination": {
"offset": 123,
"limit": 123,
"returned_count": 123,
"has_more": true,
"next_offset": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Authorization header with Bearer token
Body
application/json
Available options:
keyword, semantic, internet Show child attributes
Show child attributes
Available options:
agentic, basic, skip, unspecified Show child attributes
Show child attributes
⌘I

