Section ID:
DOC-API-MODEL-schema-1igd5iut01#overview
MemorySearchParams
Parameters used to retrieve relevant memories during generation.
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1igd5iut01#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1igd5iut01#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1igd5iut01#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1igd5iut01#request-field-queryquery | string | Optional | Text submitted to memory retrieval for this generation. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#request-field-topktopK | string (int64) | Optional | Maximum memory matches requested during generation-context retrieval. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#request-field-thresholdthreshold | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum relevance threshold requested for the memory query. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#request-field-rerankrerank | boolean | Optional | Whether reranking was requested for the memory search. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#request-field-resultsreturnedresultsReturned | string (int64) | Optional | Number of memory records returned by the search. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#request-field-relationsreturnedrelationsReturned | string (int64) | Optional | Number of graph relationships returned by the search. Pattern: ^-?\d+$. |
In responses
Section ID: DOC-API-MODEL-schema-1igd5iut01#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1igd5iut01#field-querySection ID: DOC-API-MODEL-schema-1igd5iut01#response-field-queryquery | string | Optional | Text submitted to memory retrieval for this generation. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#field-topkSection ID: DOC-API-MODEL-schema-1igd5iut01#response-field-topktopK | string (int64) | Optional | Maximum memory matches requested during generation-context retrieval. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#field-thresholdSection ID: DOC-API-MODEL-schema-1igd5iut01#response-field-thresholdthreshold | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum relevance threshold requested for the memory query. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#field-rerankSection ID: DOC-API-MODEL-schema-1igd5iut01#response-field-rerankrerank | boolean | Optional | Whether reranking was requested for the memory search. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#field-resultsreturnedSection ID: DOC-API-MODEL-schema-1igd5iut01#response-field-resultsreturnedresultsReturned | string (int64) | Optional | Number of memory records returned by the search. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1igd5iut01#field-relationsreturnedSection ID: DOC-API-MODEL-schema-1igd5iut01#response-field-relationsreturnedrelationsReturned | string (int64) | Optional | Number of graph relationships returned by the search. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1igd5iut01#where-used
| Reference | Relationship |
|---|---|
| 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 |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1igd5iut01