garden.engram.searchMemories

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Vector search over a space's memories. The caller embeds its query with the space's model and query prefix and sends vector, model and modelDigest. A service that runs the space's model may instead embed q itself when no vector is sent. A service that doesn't embed queries answers InvalidRequest, and one that doesn't run the space's model answers ModelNotHosted. Requires a space credential for the space, presented with an HTTP message signature whose audience is this service's DID.",
      "errors": [
        {
          "description": "This service does not index the space.",
          "name": "UnknownSpace"
        },
        {
          "description": "The space's authority hasn't declared an embedding model.",
          "name": "NoModel"
        },
        {
          "description": "The query's model isn't the space's model. Re-read the space's config.",
          "name": "ModelMismatch"
        },
        {
          "description": "q was sent without a vector, and this service doesn't run the space's model. Embed the query with the space's model and send the vector.",
          "name": "ModelNotHosted"
        },
        {
          "description": "This service doesn't embed queries for this space's authority.",
          "name": "TextSearchNotAllowed"
        },
        {
          "description": "Too many queries are being embedded. Retry shortly.",
          "name": "EmbedderBusy"
        },
        {
          "description": "The space's index is loading. Retry shortly.",
          "name": "IndexLoading"
        },
        {
          "description": "Too many searches for this space.",
          "name": "RateLimitExceeded"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "approximate": {
              "description": "Set when the index couldn't re-rank in time, so results are ranked by a coarser comparison and may be less precise.",
              "type": "boolean"
            },
            "memories": {
              "items": {
                "ref": "garden.engram.defs#memoryView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "memories"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "author": {
            "description": "Only memories written by this DID.",
            "format": "did",
            "type": "string"
          },
          "limit": {
            "default": 10,
            "maximum": 50,
            "minimum": 1,
            "type": "integer"
          },
          "model": {
            "description": "Must match the space's model.",
            "type": "string"
          },
          "modelDigest": {
            "description": "Must match the space's model digest.",
            "type": "string"
          },
          "q": {
            "description": "The query's text. Sent with a vector, it isn't used for ranking. Sent alone, a service that embeds queries (at most 1000 characters) embeds it with the space's model and query prefix.",
            "maxLength": 4000,
            "type": "string"
          },
          "since": {
            "description": "Only memories created at or after this time.",
            "format": "datetime",
            "type": "string"
          },
          "space": {
            "description": "The space URI.",
            "type": "string"
          },
          "tags": {
            "description": "Only memories carrying every one of these tags.",
            "items": {
              "type": "string"
            },
            "maxLength": 16,
            "type": "array"
          },
          "vector": {
            "description": "The query's vector: little-endian IEEE half precision, base64url-encoded without padding.",
            "maxLength": 43000,
            "type": "string"
          }
        },
        "required": [
          "space"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "garden.engram.searchMemories",
  "lexicon": 1
}