Update Collection Item

PATCH /v1/vector_store/{id}/items/{itemid} View .md

Updates a vector store collection item record.

Path parameters

id string required

The ID of the vector store collection.
itemid string required

The ID of the vector store collection item.

Body

application/json

Update Vector Store Item Request Payload

description string required

A description of the contents in this collection item record.

Responses

application/json · get-vector-store-item-response-payload

1 field

item object

An object representing an embeddings record within a vector store collection.
4 fields
- id string
  
  The unique ID of the vector store collection item.
- created string
  
  The UTC creation timestamp of the collection item in ISO 8601 format.
- description string
  
  The short description of the content stored as embeddings for this record.
- content string
  
  The full text of the content stored as embeddings for this record.

curl -X PATCH https://api.vultrinference.com/v1/vector_store/{id}/items/{itemid} \
  -H "Authorization: Bearer $VULTR_INFERENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string"
  }'

import os
import requests

response = requests.patch(
    "https://api.vultrinference.com/v1/vector_store/{id}/items/{itemid}",
    headers={"Authorization": f"Bearer {os.environ['VULTR_INFERENCE_API_KEY']}"},
    json={
        "description": "string",
    },
)
print(response.json())

const response = await fetch("https://api.vultrinference.com/v1/vector_store/{id}/items/{itemid}", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.VULTR_INFERENCE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "string"
  }),
});
console.log(await response.json());

Response · 202

{
    "item": {
        "id": "string",
        "created": "string",
        "description": "string",
        "content": "string"
    }
}