The semantic search index: `enabled`, `provider`, `model`, `files`, `passages`, `pending`,

POST

/datanotes/operations/describe_semantic_index/

curl --request POST \
  --url https://example.com/datanotes/operations/describe_semantic_index/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

The semantic search index: enabled, provider, model, files, passages, pending, running, last_sync, last_error. sync_semantic_index brings it up to date.

Authorizations

• bearer

Request Body

Media typeapplication/json

object

Example ^generated

{}

Responses

200

Done.

Media typeapplication/json

SemanticStatus

State of the semantic index (action status).

object

enabled

required

boolean

provider

required

string

model

required

string

files

required

Notes indexed.

integer

passages

required

Passages indexed.

integer

pending

required

Notes waiting to be (re)embedded.

integer

running

required

An update is running.

boolean

last_sync

string

last_error

string

Example ^generated

{
  "enabled": true,
  "provider": "example",
  "model": "example",
  "files": 1,
  "passages": 1,
  "pending": 1,
  "running": true,
  "last_sync": "example",
  "last_error": "example"
}

400

Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

401

Missing or wrong bearer token.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}

500

Unexpected error.

Media typeapplication/json

object

error

required

What went wrong, for a person or an agent.

string

Example ^generated

{
  "error": "example"
}