EmbeddingIndexRead

Fields

13 fields

active · required

EmbeddingGenerationRead

configured · required

EmbeddingGenerationRead

configured_note

string or null

families

array of EmbeddingFamilyProgress

in_sync · required

boolean

last_error

string or null

processed

integer

requested_at

string (date-time) or null

stalled

boolean or null

status · required

string

switched_at

string (date-time) or null

target

EmbeddingGenerationRead or null

total

integer or null

Raw schema (JSON)

{
  "properties": {
    "active": {
      "$ref": "#/components/schemas/EmbeddingGenerationRead"
    },
    "configured": {
      "$ref": "#/components/schemas/EmbeddingGenerationRead"
    },
    "configured_note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Configured Note"
    },
    "families": {
      "items": {
        "$ref": "#/components/schemas/EmbeddingFamilyProgress"
      },
      "title": "Families",
      "type": "array"
    },
    "in_sync": {
      "title": "In Sync",
      "type": "boolean"
    },
    "last_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Error"
    },
    "processed": {
      "default": 0,
      "title": "Processed",
      "type": "integer"
    },
    "requested_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Requested At"
    },
    "stalled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Stalled"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "switched_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Switched At"
    },
    "target": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/EmbeddingGenerationRead"
        },
        {
          "type": "null"
        }
      ]
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Total"
    }
  },
  "required": [
    "active",
    "configured",
    "in_sync",
    "status"
  ],
  "title": "EmbeddingIndexRead",
  "type": "object"
}

Used by endpoints

4 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/settings/ai/embedding-index — Get Embedding Index
• POST /api/v1/settings/ai/embedding-index/rebuild — Rebuild Embedding Index
• GET /api/v1/settings/ai — Get Ai Config
• PUT /api/v1/settings/ai — Update Ai Config

Used by schemas

• AIConfigRead

More details

• Specification: OpenAPI JSON