import Morphik from 'morphik';
const client = new Morphik({
apiKey: 'My API Key',
});
const response = await client.retrieve.chunks.createGrouped({ query: 'x' });
console.log(response.chunks);
{
"chunks": [
{
"content": "<string>",
"score": 123,
"document_id": "<string>",
"chunk_number": 123,
"metadata": {},
"content_type": "<string>",
"filename": "<string>",
"download_url": "<string>",
"is_padding": true
}
],
"groups": [
{
"main_chunk": {
"content": "<string>",
"score": 123,
"document_id": "<string>",
"chunk_number": 123,
"metadata": {},
"content_type": "<string>",
"filename": "<string>",
"download_url": "<string>",
"is_padding": true
},
"padding_chunks": [
{
"content": "<string>",
"score": 123,
"document_id": "<string>",
"chunk_number": 123,
"metadata": {},
"content_type": "<string>",
"filename": "<string>",
"download_url": "<string>",
"is_padding": true
}
],
"total_chunks": 123
}
],
"total_results": 123,
"has_padding": true
}
Retrieve relevant chunks with grouped response format.
Returns both flat results (for backward compatibility) and grouped results (for UI). When padding > 0, groups chunks by main matches and their padding chunks.
Args: request: RetrieveRequest containing query, filters, padding, etc. auth: Authentication context
Returns: GroupedChunkResponse: Contains both flat chunks and grouped chunks
import Morphik from 'morphik';
const client = new Morphik({
apiKey: 'My API Key',
});
const response = await client.retrieve.chunks.createGrouped({ query: 'x' });
console.log(response.chunks);
{
"chunks": [
{
"content": "<string>",
"score": 123,
"document_id": "<string>",
"chunk_number": 123,
"metadata": {},
"content_type": "<string>",
"filename": "<string>",
"download_url": "<string>",
"is_padding": true
}
],
"groups": [
{
"main_chunk": {
"content": "<string>",
"score": 123,
"document_id": "<string>",
"chunk_number": 123,
"metadata": {},
"content_type": "<string>",
"filename": "<string>",
"download_url": "<string>",
"is_padding": true
},
"padding_chunks": [
{
"content": "<string>",
"score": 123,
"document_id": "<string>",
"chunk_number": 123,
"metadata": {},
"content_type": "<string>",
"filename": "<string>",
"download_url": "<string>",
"is_padding": true
}
],
"total_chunks": 123
}
],
"total_results": 123,
"has_padding": true
}
Base retrieve request model
Successful Response
Response that includes both flat results and grouped results for UI
Was this page helpful?