Ir para o conteúdo

Obter as informações de um documento

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

Retrieve the information of a 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.

Responses

  • 200 — Document details retrieved successfully.

Exemplos de Requisições

curl -X GET   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234   
  -H "x-api-key: SUA_CHAVE_API"

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 getDocumentInfo = async (vectorStoreId, documentId) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/${documentId}`, {
    method: 'GET',
    headers: {
      'x-api-key': 'SUA_CHAVE_API'
    }
  });

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

getDocumentInfo('vs_abc123', 1234);

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

def get_document_info(vector_store_id, document_id):
    headers = {
        "x-api-key": "SUA_CHAVE_API"
    }

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

    data = response.json()
    print(data)

get_document_info('vs_abc123', 1234)

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 contendo o documento.
document-id integer Obrigatório. O ID do documento a ser recuperado.

Formato de Resposta

{
  "id": 1234,
  "name": "Manual do Produto.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "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-15T10:30: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
401 Não Autorizado - Chave de API inválida ou ausente
404 Não Encontrado - Armazenamento de Vetores ou documento não encontrado
500 Erro Interno do Servidor

Este endpoint recupera informações detalhadas sobre um documento específico no armazenamento de vetores. É útil para verificar o status de processamento de documentos individuais e recuperar metadados como tipo de arquivo, tamanho e timestamps. Isso pode ser particularmente útil ao solucionar problemas com o processamento de documentos ou quando você precisa verificar se um documento foi indexado corretamente.