Vector Upsert

Upsert vector embeddings

Upsert vector embeddings of documents in a chatflow

POST/vector/upsert/{id}

Authorization

bearerAuth

Path parameters

id*string

Chatflow ID

Body

application/jsonmultipart/form-data

stopNodeIdstring

In cases when you have multiple vector store nodes, you can specify the node ID to store the vectors

Example: "node_1"

overrideConfigobject

The configuration to override the default vector upsert settings (optional)

Response

200400404422500

Vector embeddings upserted successfully

Body

application/json

numAddednumber

Number of vectors added

Example: 1

numDeletednumber

Number of vectors deleted

Example: 1

numUpdatednumber

Number of vectors updated

Example: 1

numSkippednumber

Number of vectors skipped (not added, deleted, or updated)

Example: 1

addedDocsarray of Document (object)

Request

JavaScriptCurlPython

const response = await fetch('/vector/upsert/{id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "numAdded": 1,
  "numDeleted": 1,
  "numUpdated": 1,
  "numSkipped": 1,
  "addedDocs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ]
}