Gå til indholdet

Opdater filens indhold i en Vektorbutik

PATCH /vector-stores/{vector-store-id}/documents/{document-id}/

Update a specific document in a vector store.

Parameter In Type Required Description
vector-store-id path string yes The ID of the vector store.
document-id path integer yes The ID of the document.
x-api-key header string yes The API key for authentication.

Request body

Field Type Required Description
name string The new name for the document.

Responses

  • 200 — Document updated successfully.

Eksempelanmodninger

curl -X PATCH   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234/   
  -H "x-api-key: YOUR_API_KEY"   
  -H "Content-Type: application/json"   
  -d '{
    "name": "Opdateret Produktoversigt"
  }'

Info

Erstat YOUR_API_KEY med din faktiske Vector Store API-nøgle, vs_abc123 med dit Vector Store ID, og 1234 med dokument-ID'et.

const updateDocument = async (vectorStoreId, documentId, newName) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/${documentId}/`, {
    method: 'PATCH',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: newName
    })
  });

  const data = await response.json();
  console.log(data);
};

updateDocument('vs_abc123', 1234, 'Opdateret Produktoversigt');

Info

Erstat YOUR_API_KEY med din faktiske Vector Store API-nøgle, vs_abc123 med dit Vector Store ID, og 1234 med dokument-ID'et.

import requests
import json

def update_document(vector_store_id, document_id, new_name):
    headers = {
        "x-api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    }

    payload = {
        "name": new_name
    }

    response = requests.patch(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents/{document_id}/",
        headers=headers,
        data=json.dumps(payload)
    )

    data = response.json()
    print(data)

update_document('vs_abc123', 1234, 'Opdateret Produktoversigt')

Info

Erstat YOUR_API_KEY med din faktiske Vector Store API-nøgle, vs_abc123 med dit Vector Store ID, og 1234 med dokument-ID'et.

Sti Parametre

Parameter Type Beskrivelse
vector-store-id string Påkrævet. ID'et på vektorbutikken, der indeholder dokumentet.
document-id integer Påkrævet. ID'et på dokumentet, der skal opdateres.

Anmodningskrop

{
  "name": "Opdateret Produktoversigt"
}
Parameter Type Beskrivelse
name string Det nye navn til dokumentet.

Responsformat

{
  "id": 1234,
  "name": "Opdateret Produktoversigt",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "indekseret",
  "processing_status": "fuldført",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T11:45:00Z"
}

Godkendelse

Denne endpoint kræver godkendelse ved hjælp af en API-nøgle i x-api-key headeren.

Fejlrespons

Statuskode Beskrivelse
400 Dårlig anmodning - Ugyldigt anmodningsformat
401 Uautoriseret - Ugyldig eller manglende API-nøgle
404 Ikke fundet - Vektorbutik eller dokument ikke fundet
500 Intern serverfejl

Denne endpoint giver dig mulighed for at opdatere metadataene for et dokument i din vektorbutik. I øjeblikket kan du kun opdatere dokumentets navn. Dette er nyttigt til at forbedre dokumentorganisation og -findbarhed uden at skulle gen-upload dokumentet.

Info

Bemærk: Denne endpoint opdaterer kun dokumentets metadata, ikke dets indhold. For at opdatere indholdet skal du slette det eksisterende dokument og uploade et nyt.