H2h2o
Collections

Finds chunks related to a message using lexical search.

Finds chunks related to a message using lexical search. Chunks are sorted by relevance and similarity score to the message.

post/collections/{collection_id}/chunks/search

Request

Path parameters

collection_idstring required

Id of the collection to search within.

Request body

querystring required

Question or imperative from the end user to search a collection for.

topicsstring[] required

A list of document_ids used to filter which documents in the collection to search.

offsetinteger

How many chunks to skip before returning chunks.

limitinteger

How many chunks to return.

Response

Successful operation

textstring required

The text represented by the chunk

idinteger required

The identifier of the chunk

namestring required
sizeinteger required

The size in bytes.

pagesstring required
start_timenumber double nullable

For audio/video transcript chunks, the start time in seconds of the chunk's content, located within the document's diarization segments: exact at a speaker segment's boundary, and linearly interpolated by character position when a segment spans multiple chunks. Populated for transcript chunks returned by the get_chunks endpoint (including a mid-segment continuation chunk); null for non-transcript chunks and documents without captured segment timestamps. Chunk search and match results do not carry per-chunk times — use get_chunks, or get_audio_timestamps for full exact per-segment timing.

end_timenumber double nullable

For audio/video transcript chunks, the end time in seconds of the chunk's content, located within the document's diarization segments: exact at a speaker segment's boundary (so the final chunk ends at the true segment end) and linearly interpolated by character position within a segment that spans multiple chunks, so it never overshoots the text the chunk holds. Populated for transcript chunks returned by the get_chunks endpoint; null for non-transcript chunks and documents without captured segment timestamps. Chunk search and match results do not carry per-chunk times.

topicstring required
scorenumber double required

Changes

No recorded changes to this operation across all 1 revision of this API.