aymara_ai.pagination

Classes

SyncOffsetPage	Abstract base class for generic types.
AsyncOffsetPage	Abstract base class for generic types.

Module Contents

class aymara_ai.pagination.SyncOffsetPage

Bases: aymara_ai._base_client.BaseSyncPage[_T], aymara_ai._base_client.BasePage[_T], Generic[_T]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

items: List[_T]

count: int | None = None

next_page_info()

Return type:

Optional[aymara_ai._base_client.PageInfo]

class aymara_ai.pagination.AsyncOffsetPage

Bases: aymara_ai._base_client.BaseAsyncPage[_T], aymara_ai._base_client.BasePage[_T], Generic[_T]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

items: List[_T]

count: int | None = None

next_page_info()

Return type:

Optional[aymara_ai._base_client.PageInfo]