Ir para o conteúdo

Atualizar o conteúdo do arquivo em um Armazenamento Vetorial

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.

Exemplos de Requisições

curl -X PATCH   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234/   
  -H "x-api-key: SUA_CHAVE_API"   
  -H "Content-Type: application/json"   
  -d '{
    "name": "Visão Geral do Produto Atualizada"
  }'

Info

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store, vs_abc123 pelo seu ID do Vector Store e 1234 pelo ID do documento.

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': 'SUA_CHAVE_API',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: newName
    })
  });

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

updateDocument('vs_abc123', 1234, 'Visão Geral do Produto Atualizada');

Info

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store, vs_abc123 pelo seu ID do Vector Store e 1234 pelo ID do documento.

import requests
import json

def update_document(vector_store_id, document_id, new_name):
    headers = {
        "x-api-key": "SUA_CHAVE_API",
        "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, 'Visão Geral do Produto Atualizada')

Info

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store, vs_abc123 pelo seu ID do Vector Store e 1234 pelo ID do documento.

Parâmetros de Caminho

Parâmetro Tipo Descrição
vector-store-id string Obrigatório. O ID do armazenamento de vetores que contém o documento.
document-id integer Obrigatório. O ID do documento a ser atualizado.

Corpo da Solicitação

{
  "name": "Visão Geral do Produto Atualizado"
}
Parâmetro Tipo Descrição
name string O novo nome para o documento.

Formato de Resposta

{
  "id": 1234,
  "name": "Visão Geral do Produto Atualizado",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "indexado",
  "processing_status": "concluído",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T11:45:00Z"
}

Autenticação

Este endpoint requer autenticação usando uma chave de API no cabeçalho x-api-key.

Respostas de Erro

Código de Status Descrição
400 Solicitação Inválida - Formato de solicitação inválido
401 Não Autorizado - Chave de API inválida ou ausente
404 Não Encontrado - Armazenamento Vetorial ou documento não encontrado
500 Erro Interno do Servidor

Este endpoint permite que você atualize os metadados de um documento em seu armazenamento vetorial. Atualmente, você só pode atualizar o nome do documento. Isso é útil para melhorar a organização e a descoberta de documentos sem precisar re-enviar o documento.

Info

Nota: Este endpoint apenas atualiza os metadados do documento, não seu conteúdo. Para atualizar o conteúdo, você precisa excluir o documento existente e enviar um novo.