Cloud APIs
Answer with Quote
Welcome to RECAP
Connectors
- Connector Overview
- Connectors
Deploy Onyx
- Deploy with AWS
- Deploy on GCP
- Deploy on Azure
- Deploy on Digital Ocean
Backend APIs
Enterprise
More
- Use Cases
- FAQ
- Telemetry
- Additional Options
Cloud APIs
Answer with Quote
POST
/
query
/
answer-with-quote
{
"answer": "<string>",
"rephrase": "<string>",
"quotes": {
"quotes": [
{
"quote": "<string>",
"document_id": "<string>",
"link": "<string>",
"source_type": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
},
"citations": [
{
"citation_num": 123,
"document_id": "<string>"
}
],
"docs": {
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"link": "<string>",
"blurb": "<string>",
"source_type": "ingestion_api",
"boost": 123,
"hidden": true,
"metadata": {},
"score": 0,
"match_highlights": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"db_doc_id": 123
}
],
"rephrased_query": "<string>",
"predicted_flow": "search",
"predicted_search": "keyword",
"applied_source_filters": [
"ingestion_api"
],
"applied_time_cutoff": "2023-11-07T05:31:56Z",
"recency_bias_multiplier": 123
},
"llm_chunks_indices": [
123
],
"error_msg": "<string>",
"answer_valid": true,
"chat_message_id": 123,
"contexts": {
"contexts": [
{
"content": "<string>",
"document_id": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
}
}
Authorizations
Body
application/json
An enumeration.
Available options:
always
, never
, auto
An enumeration.
Available options:
ingestion_api
, slack
, web
, google_drive
, gmail
, requesttracker
, github
, gitlab
, guru
, bookstack
, confluence
, discourse
, slab
, salesforce
, jira
, productboard
, file
, notion
, zulip
, linear
, hubspot
, document360
, gong
, google_sites
, zendesk
, loopio
, sharepoint
, teams
, freshdesk
Response
200
application/json
Successful Response
An enumeration.
Available options:
ingestion_api
, slack
, web
, google_drive
, gmail
, requesttracker
, github
, gitlab
, guru
, bookstack
, confluence
, discourse
, slab
, salesforce
, jira
, productboard
, file
, notion
, zulip
, linear
, hubspot
, document360
, gong
, google_sites
, zendesk
, loopio
, sharepoint
, teams
, freshdesk
An enumeration.
Available options:
search
, question-answer
An enumeration.
Available options:
keyword
, semantic
, hybrid
An enumeration.
Available options:
ingestion_api
, slack
, web
, google_drive
, gmail
, requesttracker
, github
, gitlab
, guru
, bookstack
, confluence
, discourse
, slab
, salesforce
, jira
, productboard
, file
, notion
, zulip
, linear
, hubspot
, document360
, gong
, google_sites
, zendesk
, loopio
, sharepoint
, teams
, freshdesk
{
"answer": "<string>",
"rephrase": "<string>",
"quotes": {
"quotes": [
{
"quote": "<string>",
"document_id": "<string>",
"link": "<string>",
"source_type": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
},
"citations": [
{
"citation_num": 123,
"document_id": "<string>"
}
],
"docs": {
"top_documents": [
{
"document_id": "<string>",
"chunk_ind": 123,
"semantic_identifier": "<string>",
"link": "<string>",
"blurb": "<string>",
"source_type": "ingestion_api",
"boost": 123,
"hidden": true,
"metadata": {},
"score": 0,
"match_highlights": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"primary_owners": [
"<string>"
],
"secondary_owners": [
"<string>"
],
"db_doc_id": 123
}
],
"rephrased_query": "<string>",
"predicted_flow": "search",
"predicted_search": "keyword",
"applied_source_filters": [
"ingestion_api"
],
"applied_time_cutoff": "2023-11-07T05:31:56Z",
"recency_bias_multiplier": 123
},
"llm_chunks_indices": [
123
],
"error_msg": "<string>",
"answer_valid": true,
"chat_message_id": 123,
"contexts": {
"contexts": [
{
"content": "<string>",
"document_id": "<string>",
"semantic_identifier": "<string>",
"blurb": "<string>"
}
]
}
}