SimilarMemoryResponse

Fields

A memory entry with a similarity score from vector recall.

4 fields

memory · required

AgentMemoryEntryResponse

memory_reference

MemoryReference or null

retrieval_audit

object or null

similarity · required

number

Raw schema (JSON)

{
  "description": "A memory entry with a similarity score from vector recall.",
  "properties": {
    "memory": {
      "$ref": "#/components/schemas/AgentMemoryEntryResponse"
    },
    "memory_reference": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/MemoryReference"
        },
        {
          "type": "null"
        }
      ]
    },
    "retrieval_audit": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retrieval Audit"
    },
    "similarity": {
      "maximum": 1,
      "minimum": 0,
      "title": "Similarity",
      "type": "number"
    }
  },
  "required": [
    "memory",
    "similarity"
  ],
  "title": "SimilarMemoryResponse",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/memory/projects/{project_id}/recall — Recall Similar Memories

Used by schemas

• SimilarMemoryRecallResponse

More details

• Specification: OpenAPI JSON