garden.engram.defs

hailey.at

Documentation

embedding object

A vector for a memory, computed by its author from the memory's text and tags (with the space's document prefix).

Properties

dims integer Required

No description available.

minimum: 1maximum: 16000
encoding string Required

f16le: little-endian IEEE half precision, 2 bytes per dimension.

Known values: f16le
model string Required

No description available.

maxLength: 256 bytes
modelDigest string Required

No description available.

maxLength: 256 bytes
vector bytes Required

No description available.

maxLength: 32000
View raw schema
{
  "description": "A vector for a memory, computed by its author from the memory's text and tags (with the space's document prefix).",
  "properties": {
    "dims": {
      "maximum": 16000,
      "minimum": 1,
      "type": "integer"
    },
    "encoding": {
      "description": "f16le: little-endian IEEE half precision, 2 bytes per dimension.",
      "knownValues": [
        "f16le"
      ],
      "type": "string"
    },
    "model": {
      "maxLength": 256,
      "type": "string"
    },
    "modelDigest": {
      "maxLength": 256,
      "type": "string"
    },
    "vector": {
      "maxLength": 32000,
      "type": "bytes"
    }
  },
  "required": [
    "model",
    "modelDigest",
    "dims",
    "encoding",
    "vector"
  ],
  "type": "object"
}
memoryView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

similarity integer Optional

Search results only: cosine similarity to the query, scaled to 0-1000.

minimum: 0maximum: 1000
source string Optional

No description available.

tags array of string Required

No description available.

text string Required

No description available.

uri string Required

The memory's space record URI: at://{authority}/space/{spaceType}/{skey}/{author}/garden.engram.memory/{rkey}.

View raw schema
{
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "similarity": {
      "description": "Search results only: cosine similarity to the query, scaled to 0-1000.",
      "maximum": 1000,
      "minimum": 0,
      "type": "integer"
    },
    "source": {
      "type": "string"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "text": {
      "type": "string"
    },
    "uri": {
      "description": "The memory's space record URI: at://{authority}/space/{spaceType}/{skey}/{author}/garden.engram.memory/{rkey}.",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "text",
    "tags",
    "createdAt",
    "indexedAt"
  ],
  "type": "object"
}
model object

An embedding model, identified exactly. Vectors are comparable only when all three fields match.

Properties

dims integer Required

No description available.

minimum: 1maximum: 16000
model string Required

The model's name, such as nomic-embed-text.

maxLength: 256 bytes
modelDigest string Required

Pins the exact model build, such as Ollama's sha256 digest of the model. A name can point to different weights over time.

maxLength: 256 bytes
View raw schema
{
  "description": "An embedding model, identified exactly. Vectors are comparable only when all three fields match.",
  "properties": {
    "dims": {
      "maximum": 16000,
      "minimum": 1,
      "type": "integer"
    },
    "model": {
      "description": "The model's name, such as nomic-embed-text.",
      "maxLength": 256,
      "type": "string"
    },
    "modelDigest": {
      "description": "Pins the exact model build, such as Ollama's sha256 digest of the model. A name can point to different weights over time.",
      "maxLength": 256,
      "type": "string"
    }
  },
  "required": [
    "model",
    "modelDigest",
    "dims"
  ],
  "type": "object"
}

Lexicon Garden

@