INNER CODE UNIT · Python

DocumentEntry

pathwaycom/llm-app · serviette/server/main.py:64

class DocumentEntry(BaseModel):
    id: str
    name: str
    metadata: dict[str, Any] = Field(default_factory=dict)
    chunks: int


class DocumentsResponse(BaseModel):
    """``GET /api/v1/documents``: the indexed documents whose name or path
    contains ``q``. The list is left out when more than ``limit`` match —
    the caller narrows the search instead of rendering thousands of rows."""

    total: int  # documents in the index
    matched: int  # of them, matching the filter
    truncated: bool  # matched > limit: ``documents`` was not sent
    documents: list[DocumentEntry] = Field(default_factory=list)

View source record →