Common messages

Messages that are part of the nuance.nlu.common.v1beta1 package are used to reference external files like NLU models and to report job statuses.

  NLU common proto file fields  

nuance.nlu.common.v1beta1.ResourceReference

Input message for fetching an external resource.

ResourceReference fields
Field Type Description
uri string Location of the resource as a URN reference
headers string, string Field for internal use

nuance.nlu.common.v1beta1.JobStatusUpdate

Job status update to a request.

JobStatusUpdate fields
Field Type Description
job_id string Not used
status JobStatus Job status
messages JobMessage Repeated. Messages specifying about the job failure or completion.

nuance.nlu.common.v1beta1.JobStatus

Job status enum.

JobStatus enum
Name Number Description
JOB_STATUS_UNKNOWN 0 Job status not specified or unknown
JOB_STATUS_QUEUED 1 Not used
JOB_STATUS_PROCESSING 2 Job is processing
JOB_STATUS_COMPLETE 3 Job is complete
JOB_STATUS_FAILED 4 Job has failed

nuance.nlu.common.v1beta1.JobMessage

Job message.

JobMessage fields
Field Type Description
code int32 Code
message string Message
data string, string Additional key, value pairs

Scalar value types

The data types in the proto files are mapped to equivalent types in the generated client stub files.

Scalar data types
Proto Notes C++ Java Python
double double double float
float float float float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers. If your field is likely to have negative values, use sint32 instead. int32 int int
int64 Uses variable-length encoding. Inefficient for encoding negative numbers. If your field is likely to have negative values, use sint64 instead. int64 long int/long
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These encode negative numbers more efficiently than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These encode negative numbers more efficiently than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str