Response fields
object
search
object
count
integer
Total results
results
array of objects
Search results
boundingBoxes
array of objects
Coordinates corresponding to the areas of the document where the chunk appears
bottomRightX
number
The x coordinate of the lower right corner of the bounding box
bottomRightY
number
The y coordinate of the lower right corner of the bounding box
pageNumber
integer
The page number the bounding box appears on, using a 1-based array indexing (starts with page 1, not page 0)
topLeftX
number
The x coordinate of the upper left corner of the bounding box
topLeftY
number
The y coordinate of the upper left corner of the bounding box
bucketId
integer
Content bucket the search result belongs to
chunkId
string
Unique system generated ID for the chunk
documentId
string (format: uuid)
Unique system generated ID for the document
fileName
string
Name of ingested file
multimodalUrl
string (format: uri)
An image clipping of the table or figure object from the document
pageImages
array of strings
string (format: uri)
A jpg of the page the chunk appears on
score
number
Confidence score in the search result
searchData
object
Document, section, and chunk search data, both custom and system-generated
sourceUrl
string (format: uri)
Source document URL
suggestedText
string
System-generated text, re-written for LLM completions
text
string
Original text from the source document
query
string
The original search request query
score
number
Confidence score in the search results
searchQuery
string
The actual search query, if the search request query was re-written
text
string
Suggested context for LLM completion
nextToken
string
For paginated results
1{2"search": {3"count": 0,4"results": [5{6"boundingBoxes": [7{8"bottomRightX": 0,9"bottomRightY": 0,10"pageNumber": 0,11"topLeftX": 0,12"topLeftY": 013}14],15"bucketId": 0,16"chunkId": "string",17"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",18"fileName": "string",19"multimodalUrl": "http://example.com",20"pageImages": [21"http://example.com"22],23"score": 0,24"searchData": {},25"sourceUrl": "http://example.com",26"suggestedText": "string",27"text": "string"28}29],30"query": "string",31"score": 0,32"searchQuery": "string",33"text": "string",34"nextToken": "string"35}36}