Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Corpus

Information about a corpus from a custom language model.

Hierarchy

  • Corpus

Index

Properties

Properties

Optional error

error: string

If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

name

name: string

The name of the corpus.

out_of_vocabulary_words

out_of_vocabulary_words: number

_For custom models that are based on previous-generation models_, the number of OOV words extracted from the corpus. The value is 0 while the corpus is being processed.

_For custom models that are based on next-generation models_, no OOV words are extracted from corpora, so the value is always 0.

status

status: string

The status of the corpus:

  • analyzed: The service successfully analyzed the corpus. The custom model can be trained with data from the corpus.
  • being_processed: The service is still analyzing the corpus. The service cannot accept requests to add new resources or to train the custom model.
  • undetermined: The service encountered an error while processing the corpus. The error field describes the failure.

total_words

total_words: number

The total number of words in the corpus. The value is 0 while the corpus is being processed.

Generated using TypeDoc