datatypes.corpora#

class tonita.datatypes.corpora.AddCorpusResponse(corpus_id)#

Response to a request to add a corpus.

Parameters:

corpus_id (str) – The ID of the corpus to add.

class tonita.datatypes.corpora.State(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Denotes the possible states of a corpus.

Parameters:

  • INACTIVE – The corpus is inactive.

  • ACTIVE – The corpus is active.

class tonita.datatypes.corpora.ListCorporaResponse(results)#

Response to a request to enumerate all corpora.

Parameters:

results (Dict[str, State]) – Dict mapping from each corpus ID to its state.

class tonita.datatypes.corpora.GetCorpusResponse(corpus_id, exists, state=None, seconds_to_expiration=None)#

A response to a request to get information about a corpus.

Parameters:

  • corpus_id (str) – The name of the corpus ID in the request.

  • exists (bool) – True if this corpus exists. This is False if the corpus does not exist.

  • state (Optional[State]) – The state of the corpus. This will be None if the corpus does not exist.

  • seconds_to_expiration (Optional[float]) – If inactive, the amount of time (in seconds) the corpus has left until it can no longer be recovered. This will be None if the corpus does not exist.

class tonita.datatypes.corpora.DeleteCorpusResponse(corpus_id)#

Response to a request to delete a corpus.

Parameters:

corpus_id (str) – The name of the corpus ID in the request.

class tonita.datatypes.corpora.RecoverCorpusResponse(corpus_id)#

Response to a request to recover a corpus marked to be deleted.

Parameters:

corpus_id (str) – The name of the corpus ID in the request.