MOmorphik-org

Retrieve Chunks Grouped

Changed on

Retrieve relevant chunks with grouped response format.

Uses the same filter operators as /retrieve/chunks (equality, $eq/$ne, $gt/$gte/$lt/$lte, $in/$nin, $exists, $type, $regex, $contains, and the logical $and/$or/$nor/$not), with arbitrary nesting supported inside request.filters.

Returns both flat results (for backward compatibility) and grouped results (for UI). When padding > 0, groups chunks by main matches and their padding chunks.

post/retrieve/chunks/grouped

Request

  • Base URL
    https://api.morphik.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.morphik.ai/retrieve/chunks/grouped
  • Auth
    none declared

Headers

authorizationstring nullable

Request body

querystring nullable

Natural-language query used to retrieve relevant chunks or documents.

query_imagestring nullable

Base64-encoded image to use as query for Morphik multimodal retrieval. Requires use_colpali=True. Mutually exclusive with 'query'.

filtersobject nullable

Metadata filters supporting logical operators ($and/$or/$not/$nor) and field predicates ($eq/$ne/$gt/$gte/$lt/$lte/$in/$nin/$exists/$type/$regex/$contains).

kinteger

Maximum number of chunks or documents to return.

min_scorenumber

Minimum similarity score a result must meet before it is returned.

use_rerankingboolean nullable

When provided, overrides the workspace reranking configuration for this request.

use_colpaliboolean nullable

When provided, uses Morphik's finetuned ColPali style embeddings (recommended to be True for high quality retrieval).

output_format'base64' | 'url' | 'text'

Output format for image chunks in retrieval results.

paddinginteger

Number of additional chunks/pages to retrieve before and after matched chunks (ColPali only)

folder_depthinteger nullable

Folder scope depth. 0 or None = exact folder only, -1 = include all descendants, n > 0 = include descendants up to n levels deeper.

end_user_idstring nullable

Optional end-user scope for the operation

Response

Successful Response

total_resultsinteger required

Total number of unique chunks

has_paddingboolean required

Whether padding was applied to any results

Changes

  • 2d9291c3821dRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      header request parameter authorization list-of-types was widened by adding types null

    • info

      for the header request parameter authorization, the type was generalized from string to no type

  • e185c542e939Revision changes
    • breaking

      removed subschema #1 from the request property anyOf list

    • info

      added the new optional request property

    • info

      added to the request property anyOf list