embedding.delete · Umwelt docs

Reference/Commands/embedding.delete

embedding.deletecommandsince 0.1

Removes the vectors of some documents from a space.

Command lineTypeScript.NET

Request

umwelt call story.umw embedding.delete '{
  "projectId": "ball",
  "spaceId": "demo",
  "items": [{ "docType": "record", "docId": "maid-staff" }]
}'

Request

const result = await client.embeddingDelete({
  projectId: 'ball',
  spaceId: 'demo',
  items: [{ docType: 'record', docId: 'maid-staff' }],
});

Request

var result = engine.EmbeddingDelete(new DeleteEmbeddingsInput
{
    ProjectId = "ball",
    SpaceId = "demo",
    Items = new()
    {
        new EmbeddingDocRef { DocType = "record", DocId = "maid-staff" },
    },
});

Response

{
  "removed": 1
}

Payload

Field	Type	Description
`projectId`required	string	The project to write to.
`spaceId`required	string	The embedding space.
`items`required	EmbeddingDocRef[]	The documents: `docType` and `docId`.

Result

Field	Type	Description
`removed`always	integer	How many vectors were removed.

Rules

Derived data. The documents stay; they are listed as pending again.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project or the space does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also