Classes
Client
Client for interacting with the TopK API. For available regions see regions Methods Constructorcollection()
Returns
CollectionClient
collections()
CollectionsClient
dataset()
Returns
DatasetClient
datasets()
DatasetsClient
ask()
Returns
AskIterator
search()
Returns
SearchIterator
AsyncClient
Async client for interacting with the TopK API. For available regions see regions Methods Constructorcollection()
Returns
AsyncCollectionClient
collections()
AsyncCollectionsClient
dataset()
Returns
AsyncDatasetClient
datasets()
AsyncDatasetsClient
ask()
Returns
AsyncAskIterator
search()
Returns
AsyncSearchIterator
CollectionClient
Synchronous client for collection operations. Methodsget()
Returns
dict[str, dict[str, Any]]
count()
Returns
int
query()
Returns
list[dict[str, Any]]
upsert()
Returns
str
update()
LSN at which the update was applied.
If no updates were applied, this will be empty.
Parameters
Returns
str
delete()
Returns
str
list_partitions()
Returns
PartitionListIterator
delete_partition()
Returns
None
AsyncCollectionClient
Asynchronous client for collection operations. Methodsget()
Returns
Awaitable[dict[str, dict[str, Any]]]
count()
Returns
Awaitable[int]
query()
Returns
Awaitable[list[dict[str, Any]]]
upsert()
Returns
Awaitable[str]
update()
LSN at which the update was applied.
If no updates were applied, this will be empty.
Parameters
Returns
Awaitable[str]
delete()
Returns
Awaitable[str]
list_partitions()
Returns
AsyncPartitionListIterator
delete_partition()
Returns
Awaitable[None]
Collection
Represents a collection in the TopK system. PropertiesDataset
Represents a dataset in the TopK system. PropertiesListEntry
Entry in a dataset. PropertiesPartition
Represents a partition in a collection. PropertiesCollectionsClient
Synchronous client for managing collections. Methodsget()
Returns
Collection
list()
Collection]
create()
Returns
Collection
delete()
Returns
None
AsyncCollectionsClient
Asynchronous client for managing collections. Methodsget()
Returns
Awaitable[
Collection]
list()
Collection]]
create()
Returns
Awaitable[
Collection]
delete()
Returns
Awaitable[None]
DatasetsClient
Synchronous client for managing datasets. Methodsget()
Returns
Dataset
list()
Dataset]
create()
Returns
Dataset
update()
Returns
Dataset
delete()
Returns
None
DatasetClient
Synchronous client for dataset operations. Methodsupsert_file()
Returns
str
get_metadata()
Returns
dict[str, dict[str, Any]]
update_metadata()
Returns
str
delete()
Returns
str
check_handle()
Returns
bool
wait_for_handle()
Returns
None
list()
Returns
DatasetListIterator
AsyncDatasetsClient
Asynchronous client for managing datasets. Methodsget()
Returns
Awaitable[
Dataset]
list()
Dataset]]
create()
Returns
Awaitable[
Dataset]
update()
Returns
Awaitable[
Dataset]
delete()
Returns
Awaitable[None]
AsyncDatasetClient
Asynchronous client for dataset operations. Methodsupsert_file()
Returns
Awaitable[str]
get_metadata()
Returns
Awaitable[dict[str, dict[str, Any]]]
update_metadata()
Returns
Awaitable[str]
delete()
Returns
Awaitable[str]
check_handle()
Returns
Awaitable[bool]
wait_for_handle()
Returns
Awaitable[None]
list()
Returns
AsyncDatasetListIterator
Source
Represents a dataset with an optional filter. PropertiesFact
Represents a fact in an ask response. PropertiesChunk
Text chunk content. PropertiesImage
Image content. PropertiesPage
Page content with optional image. PropertiesContent
Content in a search result. One of chunk, page, or image. PropertiesSearchResult
Represents a search result in an ask response. PropertiesAnswer
Represents a final answer in an ask response. PropertiesProgress
Represents a progress update in an ask response. PropertiesAskIterator
Iterator for synchronous ask responses.AsyncAskIterator
Iterator for asynchronous ask responses.SearchIterator
Iterator for synchronous search responses.AsyncSearchIterator
Iterator for asynchronous search responses.DatasetListIterator
Iterator for synchronous dataset list responses.AsyncDatasetListIterator
Iterator for asynchronous dataset list responses.PartitionListIterator
Iterator for synchronous partition list responses.AsyncPartitionListIterator
Iterator for asynchronous partition list responses.ConsistencyLevel
Consistency level for read operations. PropertiesWaitConfig
Configuration for polling when waiting for a handle to be processed. Properties
Methods
Constructor
RetryConfig
Configuration for retry behavior. By default, retries occur in two situations:- When the server requests the client to reduce its request rate, resulting in a SlowDownError.
- When using the
query(..., lsn=N)to wait for writes to be available.
Methods
Constructor
BackoffConfig
Configuration for backoff behavior in retries. Properties
Methods
Constructor