embedding.listSpaces · Umwelt docs

Reference/Queries/embedding.listSpaces

embedding.listSpacesquerysince 0.1

Every embedding space of a project.

Command lineTypeScript.NET

Request

umwelt call story.umw embedding.listSpaces '{
  "projectId": "ball"
}'

Request

const result = await client.embeddingListSpaces({ projectId: 'ball' });

Request

var result = engine.EmbeddingListSpaces(new ProjectId { ProjectIdValue = "ball" });

Response

[
  { "id": "demo", "dimensions": 3, "model": "example-3d" }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.

A list of EmbeddingSpace, each with:

Field	Type	Description
`id`always	string	The space’s id.
`dimensions`always	integer	The length of every vector in it, from 1 to 4096.
`model`always	string	The model that makes its vectors. The engine never reads it.

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.