Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AddCorpusParams

Parameters for the addCorpus operation.

Hierarchy

  • AddCorpusParams

Index

Properties

Optional allowOverwrite

allowOverwrite: boolean

If true, the specified corpus overwrites an existing corpus with the same name. If false, the request fails if a corpus with the same name already exists. The parameter has no effect if a corpus with the same name does not already exist.

corpusFile

corpusFile: ReadableStream | Buffer

A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains non-ASCII characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters.

Make sure that you know the character encoding of the file. You must use that same encoding when working with the words in the custom language model. For more information, see Character encoding for custom words.

With the curl command, use the --data-binary option to upload the file for the request.

corpusName

corpusName: string

The name of the new corpus for the custom language model. Use a localized name that matches the language of the custom model and reflects the contents of the corpus.

  • Include a maximum of 128 characters in the name.
  • Do not use characters that need to be URL-encoded. For example, do not use spaces, slashes, backslashes, colons, ampersands, double quotes, plus signs, equals signs, questions marks, and so on in the name. (The service does not prevent the use of these characters. But because they must be URL-encoded wherever used, their use is strongly discouraged.)
  • Do not use the name of an existing corpus or grammar that is already defined for the custom model.
  • Do not use the name user, which is reserved by the service to denote custom words that are added or modified by the user.
  • Do not use the name base_lm or default_lm. Both names are reserved for future use by the service.

customizationId

customizationId: string

The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model.

Optional headers

headers: OutgoingHttpHeaders

Generated using TypeDoc