Search

Search documents

client.search.execute(, ?): SearchExecuteResponse { results, timing, total }

POST/v3/search

Search documents

client.search.documents(, ?): SearchDocumentsResponse { results, timing, total }

POST/v3/search

Search memory entries

client.search.memories(, ?): SearchMemoriesResponse { results, timing, total }

POST/v4/search

ModelsExpand Collapse

SearchExecuteResponse { results, timing, total }

results: Array<Result>

chunks: Array<Chunk>

Matching content chunks from the document

content: string

Content of the matching chunk

isRelevant: boolean

Whether this chunk is relevant to the query

score: number

Similarity score for this chunk

maximum1

minimum0

createdAt: string

Document creation date

formatdatetime

documentId: string

ID of the matching document

metadata: Record<string, unknown> | null

Document metadata

score: number

Relevance score of the match

maximum1

minimum0

title: string | null

Document title

type: string | null

Document type

updatedAt: string

Document last update date

formatdatetime

content?: string | null

Full document content (only included when includeFullDocs=true)

summary?: string | null

Document summary

timing: number

total: number

SearchDocumentsResponse { results, timing, total }

results: Array<Result>

chunks: Array<Chunk>

Matching content chunks from the document

content: string

Content of the matching chunk

isRelevant: boolean

Whether this chunk is relevant to the query

score: number

Similarity score for this chunk

maximum1

minimum0

createdAt: string

Document creation date

formatdatetime

documentId: string

ID of the matching document

metadata: Record<string, unknown> | null

Document metadata

score: number

Relevance score of the match

maximum1

minimum0

title: string | null

Document title

type: string | null

Document type

updatedAt: string

Document last update date

formatdatetime

content?: string | null

Full document content (only included when includeFullDocs=true)

summary?: string | null

Document summary

timing: number

total: number

SearchMemoriesResponse { results, timing, total }

results: Array<Result>

Array of matching memory entries and chunks with similarity scores. Contains memory results when searchMode=‘memories’, both memory and chunk results when searchMode=‘hybrid’, or only chunk results when searchMode=‘documents’. Memory results have ‘memory’ field, chunk results have ‘chunk’ field. BACKWARD COMPATIBILITY: When using deprecated include.chunks=true, only memory results are returned with chunks embedded in them (old format).

id: string

Memory entry ID or chunk ID

metadata: Record<string, unknown> | null

Memory metadata

similarity: number

Similarity score between the query and memory entry

maximum1

minimum0

updatedAt: string

Memory last update date

formatdatetime

chunk?: string

The chunk content (only present for chunk results from hybrid search)

chunks?: Array<Chunk>

Relevant chunks from associated documents (only included when chunks=true)

content: string

Content of the chunk

documentId: string

ID of the document this chunk belongs to

position: number

Position of chunk in the document (0-indexed)

score: number

Similarity score between the query and chunk

maximum1

minimum0

context?: Context { children, parents, related }

Object containing version history (parents/children via updates) and related memories (extends/derives)

children?: Array<Child>

memory: string

The contextual memory content

relation: "updates" | "extends" | "derives"

Relation type between this memory and its parent/child

One of the following:

"updates"

"extends"

"derives"

updatedAt: string

Contextual memory last update date

formatdatetime

metadata?: Record<string, unknown> | null

Contextual memory metadata

version?: number | null

Relative version distance from the primary memory (+1 for direct child, +2 for grand-child, etc.)

parents?: Array<Parent>

memory: string

The contextual memory content

relation: "updates" | "extends" | "derives"

Relation type between this memory and its parent/child

One of the following:

"updates"

"extends"

"derives"

updatedAt: string

Contextual memory last update date

formatdatetime

metadata?: Record<string, unknown> | null

Contextual memory metadata

version?: number | null

Relative version distance from the primary memory (-1 for direct parent, -2 for grand-parent, etc.)

One of the following:

documents?: Array<Document>

Associated documents for this memory entry

id: string

Document ID

createdAt: string

Document creation date

formatdatetime

updatedAt: string

Document last update date

formatdatetime

metadata?: Record<string, unknown> | null

Document metadata (only included when documents=true)

summary?: string | null

Document summary (only included when summaries=true)

title?: string

Document title (only included when documents=true)

type?: string

Document type (only included when documents=true)

filepath?: string | null

Filepath of the source document this memory or chunk came from

isAggregated?: boolean

Indicates if this memory was created by aggregating multiple source memories

memory?: string

The memory content (only present for memory results)

version?: number | null

Version number of this memory entry

timing: number

Search execution time in milliseconds

total: number

Total number of results returned