LanguageModel
public struct LanguageModel : Codable, Equatable
Information about an existing custom language model.
-
The current status of the custom language model:
pending
: The model was created but is waiting either for valid training data to be added or for the service to finish analyzing added data.ready
: The model contains valid data and is ready to be trained. If the model contains a mix of valid and invalid resources, you need to set thestrict
parameter tofalse
for the training to proceed.training
: The model is currently being trained.available
: The model is trained and ready to use.upgrading
: The model is currently being upgraded.failed
: Training of the model failed.
Declaration
Swift
public enum Status : String
-
The customization ID (GUID) of the custom language model. The Create a custom language model method returns only this field of the object; it does not return the other fields.
Declaration
Swift
public var customizationID: String
-
The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (
YYYY-MM-DDThh:mm:ss.sTZD
).Declaration
Swift
public var created: String?
-
The date and time in Coordinated Universal Time (UTC) at which the custom language model was last modified. The
created
andupdated
fields are equal when a language model is first added but has yet to be updated. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).Declaration
Swift
public var updated: String?
-
The language identifier of the custom language model (for example,
en-US
).Declaration
Swift
public var language: String?
-
The dialect of the language for the custom language model. For non-Spanish models, the field matches the language of the base model; for example,
en-US
for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created:es-ES
for Castilian Spanish (es-ES
models)es-LA
for Latin American Spanish (es-AR
,es-CL
,es-CO
, andes-PE
models)es-US
for Mexican (North American) Spanish (es-MX
models) Dialect values are case-insensitive.
Declaration
Swift
public var dialect: String?
-
For custom models that are based on previous-generation models, a list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown. For custom models that are based on next-generation models, a single version of the custom model. Only one version of a custom model that is based on a next-generation model is ever available, and upgrading does not apply.
Declaration
Swift
public var versions: [String]?
-
The GUID of the credentials for the instance of the service that owns the custom language model.
Declaration
Swift
public var owner: String?
-
The name of the custom language model.
Declaration
Swift
public var name: String?
-
The description of the custom language model.
Declaration
Swift
public var description: String?
-
The name of the language model for which the custom language model was created.
Declaration
Swift
public var baseModelName: String?
-
The current status of the custom language model:
pending
: The model was created but is waiting either for valid training data to be added or for the service to finish analyzing added data.ready
: The model contains valid data and is ready to be trained. If the model contains a mix of valid and invalid resources, you need to set thestrict
parameter tofalse
for the training to proceed.training
: The model is currently being trained.available
: The model is trained and ready to use.upgrading
: The model is currently being upgraded.failed
: Training of the model failed.
Declaration
Swift
public var status: String?
-
A percentage that indicates the progress of the custom language model’s current training. A value of
100
means that the model is fully trained. Note: Theprogress
field does not currently reflect the progress of the training. The field changes from0
to100
when training is complete.Declaration
Swift
public var progress: Int?
-
If an error occurred while adding a grammar file to the custom language model, a message that describes an
Internal Server Error
and includes the stringCannot compile grammar
. The status of the custom model is not affected by the error, but the grammar cannot be used with the model.Declaration
Swift
public var error: String?
-
If the request included unknown parameters, the following message:
Unexpected query parameter(s) ['parameters'] detected
, whereparameters
is a list that includes a quoted string for each unknown parameter.Declaration
Swift
public var warnings: String?