Vai al contenuto

Ottieni le informazioni di un 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.

Esempi di Richieste

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

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store, vs_abc123 con il tuo ID del Vector Store e 1234 con l'ID del 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': 'YOUR_API_KEY'
    }
  });

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

getDocumentInfo('vs_abc123', 1234);

Info

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store, vs_abc123 con il tuo ID del Vector Store e 1234 con l'ID del documento.

import requests

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

    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

Sostituisci YOUR_API_KEY con la tua reale chiave API del Vector Store, vs_abc123 con il tuo ID del Vector Store e 1234 con l'ID del documento.

Parametri del percorso

Parametro Tipo Descrizione
vector-store-id string Obbligatorio. L'ID del negozio di vettori contenente il documento.
document-id integer Obbligatorio. L'ID del documento da recuperare.

Formato di Risposta

{
  "id": 1234,
  "name": "Manuale del Prodotto.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "status": "indicizzato",
  "processing_status": "completato",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:30:00Z"
}

Autenticazione

Questo endpoint richiede autenticazione utilizzando una chiave API nell'intestazione x-api-key.

Risposte di Errore

Codice di Stato Descrizione
401 Non autorizzato - Chiave API non valida o mancante
404 Non trovato - Vector Store o documento non trovato
500 Errore interno del server

Questo endpoint recupera informazioni dettagliate su un documento specifico nel vector store. È utile per controllare lo stato di elaborazione dei singoli documenti e recuperare metadati come tipo di file, dimensione e timestamp. Questo può essere particolarmente utile quando si risolvono problemi con l'elaborazione dei documenti o quando è necessario verificare che un documento sia stato indicizzato correttamente.