SimilarMemoryRecallResponse

Fields

Response with ranked similar memories.

4 fields

query_signature · required

string

results · required

array of SimilarMemoryResponse

retrieval_audit

object or null

total_found · required

integer

Raw schema (JSON)

{
  "description": "Response with ranked similar memories.",
  "properties": {
    "query_signature": {
      "title": "Query Signature",
      "type": "string"
    },
    "results": {
      "items": {
        "$ref": "#/components/schemas/SimilarMemoryResponse"
      },
      "title": "Results",
      "type": "array"
    },
    "retrieval_audit": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retrieval Audit"
    },
    "total_found": {
      "title": "Total Found",
      "type": "integer"
    }
  },
  "required": [
    "query_signature",
    "results",
    "total_found"
  ],
  "title": "SimilarMemoryRecallResponse",
  "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

No other schema contains this one.

More details

• Specification: OpenAPI JSON