api.md

Status

Types:

from zeroentropy.types import StatusGetStatusResponse

Methods:

• client.status.get_status(**params) -> StatusGetStatusResponse

Collections

Types:

from zeroentropy.types import (
    CollectionDeleteResponse,
    CollectionAddResponse,
    CollectionGetListResponse,
)

Methods:

• client.collections.delete(**params) -> CollectionDeleteResponse
• client.collections.add(**params) -> CollectionAddResponse
• client.collections.get_list() -> CollectionGetListResponse

Documents

Types:

from zeroentropy.types import (
    DocumentUpdateResponse,
    DocumentDeleteResponse,
    DocumentAddResponse,
    DocumentGetInfoResponse,
    DocumentGetInfoListResponse,
    DocumentGetPageInfoResponse,
)

Methods:

• client.documents.update(**params) -> DocumentUpdateResponse
• client.documents.delete(**params) -> DocumentDeleteResponse
• client.documents.add(**params) -> DocumentAddResponse
• client.documents.get_info(**params) -> DocumentGetInfoResponse
• client.documents.get_info_list(**params) -> SyncGetDocumentInfoListCursor[DocumentGetInfoListResponse]
• client.documents.get_page_info(**params) -> DocumentGetPageInfoResponse

Queries

Types:

from zeroentropy.types import (
    QueryTopDocumentsResponse,
    QueryTopPagesResponse,
    QueryTopSnippetsResponse,
)

Methods:

• client.queries.top_documents(**params) -> QueryTopDocumentsResponse
• client.queries.top_pages(**params) -> QueryTopPagesResponse
• client.queries.top_snippets(**params) -> QueryTopSnippetsResponse

Models

Types:

from zeroentropy.types import ModelEmbedResponse, ModelRerankResponse

Methods:

• client.models.embed(**params) -> ModelEmbedResponse
• client.models.rerank(**params) -> ModelRerankResponse