Retrieval
Search
POST
/
v1
/
search
R2RSearchRequest · object
*
query
Query · string
*
query
Required
string
vector_search_settings
VectorSearchSettings · object
*
vector_search_settings
Required
object
use_vector_search
Use Vector Search · boolean
use_vector_search
boolean
search_filters
object
search_filters
object
search_limit
Search Limit · integer
search_limit
integer
do_hybrid_search
Do Hybrid Search · boolean
do_hybrid_search
boolean
kg_search_settings
KGSearchSettings · object
*
kg_search_settings
Required
object
use_kg_search
Use Kg · boolean
use_kg_search
boolean
agent_generation_config
object
agent_generation_config
object
temperature
Temperature · number
temperature
number
top_p
Top P · number
top_p
number
top_k
Top K · integer
top_k
integer
max_tokens_to_sample
Max Tokens To Sample · integer
max_tokens_to_sample
integer
model
Model · string
model
string
stream
Stream · boolean
stream
boolean
functions
array
functions
array
skip_special_tokens
Skip Special Tokens · boolean
skip_special_tokens
boolean
stop_token
string
stop_token
string
num_beams
Num Beams · integer
num_beams
integer
do_sample
Do Sample · boolean
do_sample
boolean
generate_with_chat
Generate With Chat · boolean
generate_with_chat
boolean
add_generation_kwargs
object
add_generation_kwargs
object
api_base
string
api_base
string
[
{
"id": "28e58f3c-2404-5a31-8881-abe25ec9e72f",
"score": 0.744518034650271,
"metadata": {
"text": "Aristotle[A] (Greek: Ἀριστοτέλης Aristotélēs, pronounced [aristotélɛːs]; 384–322 BC) was an Ancient Greek philosopher and polymath. His writings cover a broad range of subjects spanning the natural sciences, philosophy, linguistics, economics, politics, psychology, and the arts. As the founder of the Peripatetic school of philosophy in the Lyceum in Athens, he began the wider Aristotelian tradition that followed, which set the groundwork for the development of modern science.",
"title": "aristotle.txt",
"version": "v2",
"document_id": "ee7e3440-54aa-5f0c-a778-89fe17628687",
"extraction_id": "53a461e7-b23b-5706-aeb4-7e3a1338980f",
"associatedQuery": "Who is aristotle"
}
},
"..."
]Body
application/json
query
string
requiredvector_search_settings
object
requiredvector_search_settings.use_vector_search
boolean
default: truevector_search_settings.search_filters
object | null
vector_search_settings.search_limit
integer
default: 10vector_search_settings.do_hybrid_search
boolean
default: falsekg_search_settings
object
requiredkg_search_settings.use_kg_search
boolean
default: falsekg_search_settings.agent_generation_config
object | null
kg_search_settings.agent_generation_config.temperature
number
default: 0.1kg_search_settings.agent_generation_config.top_p
number
default: 1kg_search_settings.agent_generation_config.top_k
integer
default: 100kg_search_settings.agent_generation_config.max_tokens_to_sample
integer
default: 1024kg_search_settings.agent_generation_config.model
string
default: gpt-4okg_search_settings.agent_generation_config.stream
boolean
default: falsekg_search_settings.agent_generation_config.functions
object[] | null
kg_search_settings.agent_generation_config.skip_special_tokens
boolean
default: falsekg_search_settings.agent_generation_config.stop_token
string | null
kg_search_settings.agent_generation_config.num_beams
integer
default: 1kg_search_settings.agent_generation_config.do_sample
boolean
default: truekg_search_settings.agent_generation_config.generate_with_chat
boolean
default: falsekg_search_settings.agent_generation_config.add_generation_kwargs
object | null
kg_search_settings.agent_generation_config.api_base
string | null
Response
200 - application/json
results
string[]
Was this page helpful?
[
{
"id": "28e58f3c-2404-5a31-8881-abe25ec9e72f",
"score": 0.744518034650271,
"metadata": {
"text": "Aristotle[A] (Greek: Ἀριστοτέλης Aristotélēs, pronounced [aristotélɛːs]; 384–322 BC) was an Ancient Greek philosopher and polymath. His writings cover a broad range of subjects spanning the natural sciences, philosophy, linguistics, economics, politics, psychology, and the arts. As the founder of the Peripatetic school of philosophy in the Lyceum in Athens, he began the wider Aristotelian tradition that followed, which set the groundwork for the development of modern science.",
"title": "aristotle.txt",
"version": "v2",
"document_id": "ee7e3440-54aa-5f0c-a778-89fe17628687",
"extraction_id": "53a461e7-b23b-5706-aeb4-7e3a1338980f",
"associatedQuery": "Who is aristotle"
}
},
"..."
]