languagetranslatorv3

type CreateModelOptions struct {
	// The ID of the translation model to use as the base for customization. To see available models and IDs, use the `List
	// models` method. Most models that are provided with the service are customizable. In addition, all models that you
	// create with parallel corpora customization can be further customized with a forced glossary.
	BaseModelID *string `json:"base_model_id" validate:"required"`

	// A file with forced glossary terms for the source and target languages. The customizations in the file completely
	// overwrite the domain translation data, including high frequency or high confidence phrase translations.
	//
	// You can upload only one glossary file for a custom model, and the glossary can have a maximum size of 10 MB. A
	// forced glossary must contain single words or short phrases. For more information, see **Supported file formats** in
	// the method description.
	//
	// *With `curl`, use `--form forced_glossary=@{filename}`.*.
	ForcedGlossary io.ReadCloser `json:"forced_glossary,omitempty"`

	// A file with parallel sentences for the source and target languages. You can upload multiple parallel corpus files in
	// one request by repeating the parameter. All uploaded parallel corpus files combined must contain at least 5000
	// parallel sentences to train successfully. You can provide a maximum of 500,000 parallel sentences across all
	// corpora.
	//
	// A single entry in a corpus file can contain a maximum of 80 words. All corpora files for a custom model can have a
	// cumulative maximum size of 250 MB. For more information, see **Supported file formats** in the method description.
	//
	// *With `curl`, use `--form parallel_corpus=@{filename}`.*.
	ParallelCorpus io.ReadCloser `json:"parallel_corpus,omitempty"`

	// An optional model name that you can use to identify the model. Valid characters are letters, numbers, dashes,
	// underscores, spaces, and apostrophes. The maximum length of the name is 32 characters.
	Name *string `json:"name,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteDocumentOptions struct {
	// Document ID of the document to delete.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteModelOptions struct {
	// Model ID of the model to delete.
	ModelID *string `json:"model_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteModelResult struct {
	// "OK" indicates that the model was successfully deleted.
	Status *string `json:"status" validate:"required"`
}

type DocumentList struct {
	// An array of all previously submitted documents.
	Documents []DocumentStatus `json:"documents" validate:"required"`
}

type DocumentStatus struct {
	// System generated ID identifying a document being translated using one specific translation model.
	DocumentID *string `json:"document_id" validate:"required"`

	// filename from the submission (if it was missing in the multipart-form, 'noname.<ext matching content type>' is used.
	Filename *string `json:"filename" validate:"required"`

	// The status of the translation job associated with a submitted document.
	Status *string `json:"status" validate:"required"`

	// A globally unique string that identifies the underlying model that is used for translation.
	ModelID *string `json:"model_id" validate:"required"`

	// Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be
	// absent or an empty string.
	BaseModelID *string `json:"base_model_id,omitempty"`

	// Translation source language code.
	Source *string `json:"source" validate:"required"`

	// A score between 0 and 1 indicating the confidence of source language detection. A higher value indicates greater
	// confidence. This is returned only when the service automatically detects the source language.
	DetectedLanguageConfidence *float64 `json:"detected_language_confidence,omitempty"`

	// Translation target language code.
	Target *string `json:"target" validate:"required"`

	// The time when the document was submitted.
	Created *strfmt.DateTime `json:"created" validate:"required"`

	// The time when the translation completed.
	Completed *strfmt.DateTime `json:"completed,omitempty"`

	// An estimate of the number of words in the source document. Returned only if `status` is `available`.
	WordCount *int64 `json:"word_count,omitempty"`

	// The number of characters in the source document, present only if status=available.
	CharacterCount *int64 `json:"character_count,omitempty"`
}

type GetDocumentStatusOptions struct {
	// The document ID of the document.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetModelOptions struct {
	// Model ID of the model to get.
	ModelID *string `json:"model_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetTranslatedDocumentOptions struct {
	// The document ID of the document that was submitted for translation.
	DocumentID *string `json:"document_id" validate:"required,ne="`

	// The type of the response: application/powerpoint, application/mspowerpoint, application/x-rtf, application/json,
	// application/xml, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
	// application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation,
	// application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document,
	// application/vnd.oasis.opendocument.spreadsheet, application/vnd.oasis.opendocument.presentation,
	// application/vnd.oasis.opendocument.text, application/pdf, application/rtf, text/html, text/json, text/plain,
	// text/richtext, text/rtf, or text/xml. A character encoding can be specified by including a `charset` parameter. For
	// example, 'text/html;charset=utf-8'.
	Accept *string `json:"Accept,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type IdentifiableLanguage struct {
	// The language code for an identifiable language.
	Language *string `json:"language" validate:"required"`

	// The name of the identifiable language.
	Name *string `json:"name" validate:"required"`
}

type IdentifiableLanguages struct {
	// A list of all languages that the service can identify.
	Languages []IdentifiableLanguage `json:"languages" validate:"required"`
}

type IdentifiedLanguage struct {
	// The language code for an identified language.
	Language *string `json:"language" validate:"required"`

	// The confidence score for the identified language.
	Confidence *float64 `json:"confidence" validate:"required"`
}

type IdentifiedLanguages struct {
	// A ranking of identified languages with confidence scores.
	Languages []IdentifiedLanguage `json:"languages" validate:"required"`
}

type IdentifyOptions struct {
	// Input text in UTF-8 format.
	Text *string `json:"text" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Language struct {
	// The language code for the language (for example, `af`).
	Language *string `json:"language,omitempty"`

	// The name of the language in English (for example, `Afrikaans`).
	LanguageName *string `json:"language_name,omitempty"`

	// The native name of the language (for example, `Afrikaans`).
	NativeLanguageName *string `json:"native_language_name,omitempty"`

	// The country code for the language (for example, `ZA` for South Africa).
	CountryCode *string `json:"country_code,omitempty"`

	// Indicates whether words of the language are separated by whitespace: `true` if the words are separated; `false`
	// otherwise.
	WordsSeparated *bool `json:"words_separated,omitempty"`

	// Indicates the direction of the language: `right_to_left` or `left_to_right`.
	Direction *string `json:"direction,omitempty"`

	// Indicates whether the language can be used as the source for translation: `true` if the language can be used as the
	// source; `false` otherwise.
	SupportedAsSource *bool `json:"supported_as_source,omitempty"`

	// Indicates whether the language can be used as the target for translation: `true` if the language can be used as the
	// target; `false` otherwise.
	SupportedAsTarget *bool `json:"supported_as_target,omitempty"`

	// Indicates whether the language supports automatic detection: `true` if the language can be detected automatically;
	// `false` otherwise.
	Identifiable *bool `json:"identifiable,omitempty"`
}

type LanguageTranslatorV3 struct {
	Service *core.BaseService

	// Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is
	// `2018-05-01`.
	Version *string
}

type LanguageTranslatorV3Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is
	// `2018-05-01`.
	Version *string `validate:"required"`
}

type Languages struct {
	// An array of supported languages with information about each language.
	Languages []Language `json:"languages" validate:"required"`
}

type ListDocumentsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListIdentifiableLanguagesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListLanguagesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListModelsOptions struct {
	// Specify a language code to filter results by source language.
	Source *string `json:"source,omitempty"`

	// Specify a language code to filter results by target language.
	Target *string `json:"target,omitempty"`

	// If the `default` parameter isn't specified, the service returns all models (default and non-default) for each
	// language pair. To return only default models, set this parameter to `true`. To return only non-default models, set
	// this parameter to `false`. There is exactly one default model, the IBM-provided base model, per language pair.
	Default *bool `json:"default,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type TranslateDocumentOptions struct {
	// The contents of the source file to translate. The maximum file size for document translation is 20 MB for service
	// instances on the Standard, Advanced, and Premium plans, and 2 MB for service instances on the Lite plan. For more
	// information, see [Supported file formats
	// (Beta)](https://cloud.ibm.com/docs/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats).
	File io.ReadCloser `json:"file" validate:"required"`

	// The filename for file.
	Filename *string `json:"filename" validate:"required"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

	// The model to use for translation. For example, `en-de` selects the IBM-provided base model for English-to-German
	// translation. A model ID overrides the `source` and `target` parameters and is required if you use a custom model. If
	// no model ID is specified, you must specify at least a target language.
	ModelID *string `json:"model_id,omitempty"`

	// Language code that specifies the language of the source document. If omitted, the service derives the source
	// language from the input text. The input must contain sufficient text for the service to identify the language
	// reliably.
	Source *string `json:"source,omitempty"`

	// Language code that specifies the target language for translation. Required if model ID is not specified.
	Target *string `json:"target,omitempty"`

	// To use a previously submitted document as the source for a new translation, enter the `document_id` of the document.
	DocumentID *string `json:"document_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type TranslateOptions struct {
	// Input text in UTF-8 encoding. Submit a maximum of 50 KB (51,200 bytes) of text with a single request. Multiple
	// elements result in multiple translations in the response.
	Text []string `json:"text" validate:"required"`

	// The model to use for translation. For example, `en-de` selects the IBM-provided base model for English-to-German
	// translation. A model ID overrides the `source` and `target` parameters and is required if you use a custom model. If
	// no model ID is specified, you must specify at least a target language.
	ModelID *string `json:"model_id,omitempty"`

	// Language code that specifies the language of the input text. If omitted, the service derives the source language
	// from the input text. The input must contain sufficient text for the service to identify the language reliably.
	Source *string `json:"source,omitempty"`

	// Language code that specifies the target language for translation. Required if model ID is not specified.
	Target *string `json:"target,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Translation struct {
	// Translation output in UTF-8.
	Translation *string `json:"translation" validate:"required"`
}

type TranslationModel struct {
	// A globally unique string that identifies the underlying model that is used for translation.
	ModelID *string `json:"model_id" validate:"required"`

	// Optional name that can be specified when the model is created.
	Name *string `json:"name,omitempty"`

	// Translation source language code.
	Source *string `json:"source,omitempty"`

	// Translation target language code.
	Target *string `json:"target,omitempty"`

	// Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be an
	// empty string.
	BaseModelID *string `json:"base_model_id,omitempty"`

	// The domain of the translation model.
	Domain *string `json:"domain,omitempty"`

	// Whether this model can be used as a base for customization. Customized models are not further customizable, and some
	// base models are not customizable.
	Customizable *bool `json:"customizable,omitempty"`

	// Whether or not the model is a default model. A default model is the model for a given language pair that will be
	// used when that language pair is specified in the source and target parameters.
	DefaultModel *bool `json:"default_model,omitempty"`

	// Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created
	// the model.
	Owner *string `json:"owner,omitempty"`

	// Availability of a model.
	Status *string `json:"status,omitempty"`
}

type TranslationModels struct {
	// An array of available models.
	Models []TranslationModel `json:"models" validate:"required"`
}

type TranslationResult struct {
	// An estimate of the number of words in the input text.
	WordCount *int64 `json:"word_count" validate:"required"`

	// Number of characters in the input text.
	CharacterCount *int64 `json:"character_count" validate:"required"`

	// The language code of the source text if the source language was automatically detected.
	DetectedLanguage *string `json:"detected_language,omitempty"`

	// A score between 0 and 1 indicating the confidence of source language detection. A higher value indicates greater
	// confidence. This is returned only when the service automatically detects the source language.
	DetectedLanguageConfidence *float64 `json:"detected_language_confidence,omitempty"`

	// List of translation output in UTF-8, corresponding to the input text entries.
	Translations []Translation `json:"translations" validate:"required"`
}