Section ID:
DOC-API-MODEL-schema-1ie9a4bgk5#overview
MemoryReference
A memory record retrieved and included in generation context.
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-1ie9a4bgk5#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#request-field-memoryidmemoryId | string | Optional | Identifier of the retrieved memory record. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#request-field-scorescore | number (double) or string (NaN, Infinity, -Infinity) | Optional | Relevance score reported by the memory provider for this match. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#request-field-memorytextmemoryText | string | Optional | Text of the retrieved memory record. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#request-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#request-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
In responses
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#field-memoryidSection ID: DOC-API-MODEL-schema-1ie9a4bgk5#response-field-memoryidmemoryId | string | Optional | Identifier of the retrieved memory record. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#field-scoreSection ID: DOC-API-MODEL-schema-1ie9a4bgk5#response-field-scorescore | number (double) or string (NaN, Infinity, -Infinity) | Optional | Relevance score reported by the memory provider for this match. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#field-memorytextSection ID: DOC-API-MODEL-schema-1ie9a4bgk5#response-field-memorytextmemoryText | string | Optional | Text of the retrieved memory record. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#field-createdatSection ID: DOC-API-MODEL-schema-1ie9a4bgk5#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#field-updatedatSection ID: DOC-API-MODEL-schema-1ie9a4bgk5#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Where used
Section ID: DOC-API-MODEL-schema-1ie9a4bgk5#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-1ie9a4bgk5