MemorySearchParams
Parameters used to retrieve relevant memories during generation.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
query | string | Optional | Text submitted to memory retrieval for this generation. |
topK | integer (int32) | Optional | Maximum memory matches requested during generation-context retrieval. Minimum: -2147483648. Maximum: 2147483647. |
threshold | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum relevance threshold requested for the memory query. |
rerank | boolean | Optional | Whether reranking was requested for the memory search. |
resultsReturned | integer (int32) | Optional | Number of memory records returned by the search. Minimum: -2147483648. Maximum: 2147483647. |
relationsReturned | integer (int32) | Optional | Number of graph relationships returned by the search. Minimum: -2147483648. Maximum: 2147483647. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
query | string | Optional | Text submitted to memory retrieval for this generation. |
topK | integer (int32) | Optional | Maximum memory matches requested during generation-context retrieval. Minimum: -2147483648. Maximum: 2147483647. |
threshold | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum relevance threshold requested for the memory query. |
rerank | boolean | Optional | Whether reranking was requested for the memory search. |
resultsReturned | integer (int32) | Optional | Number of memory records returned by the search. Minimum: -2147483648. Maximum: 2147483647. |
relationsReturned | integer (int32) | Optional | Number of graph relationships returned by the search. Minimum: -2147483648. Maximum: 2147483647. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
query | string | Optional | Text submitted to memory retrieval for this generation. |
top_k | integer (int32) | Optional | Maximum memory matches requested during generation-context retrieval. Minimum: -2147483648. Maximum: 2147483647. |
threshold | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum relevance threshold requested for the memory query. |
rerank | boolean | Optional | Whether reranking was requested for the memory search. |
results_returned | integer (int32) | Optional | Number of memory records returned by the search. Minimum: -2147483648. Maximum: 2147483647. |
relations_returned | integer (int32) | Optional | Number of graph relationships returned by the search. Minimum: -2147483648. Maximum: 2147483647. |
Where used
| Reference | Relationship |
|---|---|
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-memory-search-params.