Gå til indholdet

Få information om et dokument

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.

Eksempelanmodninger

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

Info

Erstat DIN_API_NØGLE med din faktiske Vector Store API-nøgle, vs_abc123 med dit Vector Store ID, og 1234 med dokument-ID'en.

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': 'DIN_API_NØGLE'
    }
  });

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

getDocumentInfo('vs_abc123', 1234);

Info

Erstat DIN_API_NØGLE med din faktiske Vector Store API-nøgle, vs_abc123 med dit Vector Store ID, og 1234 med dokument-ID'en.

import requests

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

    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

Erstat DIN_API_NØGLE med din faktiske Vector Store API-nøgle, vs_abc123 med dit Vector Store ID, og 1234 med dokument-ID'en.

Sti Parametre

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

Responsformat

{
  "id": 1234,
  "name": "Produktmanual.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "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-15T10:30:00Z"
}

Godkendelse

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

Fejl Svar

Statuskode Beskrivelse
401 Uautoriseret - Ugyldig eller manglende API-nøgle
404 Ikke Fundet - Vektorbutik eller dokument ikke fundet
500 Intern Serverfejl

Denne endpoint henter detaljerede oplysninger om et specifikt dokument i vektorbutikken. Det er nyttigt til at tjekke behandlingsstatus for individuelle dokumenter og hente metadata som filtype, størrelse og tidsstempler. Dette kan være særligt nyttigt, når man fejlfinder problemer med dokumentbehandling eller når man har brug for at bekræfte, at et dokument er blevet korrekt indekseret.