Represents a Model.
Package
@google-cloud/automlConstructors
(constructor)(properties)
constructor(properties?: google.cloud.automl.v1.IModel);Constructs a new Model.
| Parameter | |
|---|---|
| Name | Description |
properties |
IModel
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Model createTime.
datasetId
public datasetId: string;Model datasetId.
deploymentState
public deploymentState: (google.cloud.automl.v1.Model.DeploymentState|keyof typeof google.cloud.automl.v1.Model.DeploymentState);Model deploymentState.
displayName
public displayName: string;Model displayName.
etag
public etag: string;Model etag.
imageClassificationModelMetadata
public imageClassificationModelMetadata?: (google.cloud.automl.v1.IImageClassificationModelMetadata|null);Model imageClassificationModelMetadata.
imageObjectDetectionModelMetadata
public imageObjectDetectionModelMetadata?: (google.cloud.automl.v1.IImageObjectDetectionModelMetadata|null);Model imageObjectDetectionModelMetadata.
labels
public labels: { [k: string]: string };Model labels.
modelMetadata
public modelMetadata?: ("translationModelMetadata"|"imageClassificationModelMetadata"|"textClassificationModelMetadata"|"imageObjectDetectionModelMetadata"|"textExtractionModelMetadata"|"textSentimentModelMetadata");Model modelMetadata.
name
public name: string;Model name.
textClassificationModelMetadata
public textClassificationModelMetadata?: (google.cloud.automl.v1.ITextClassificationModelMetadata|null);Model textClassificationModelMetadata.
textExtractionModelMetadata
public textExtractionModelMetadata?: (google.cloud.automl.v1.ITextExtractionModelMetadata|null);Model textExtractionModelMetadata.
textSentimentModelMetadata
public textSentimentModelMetadata?: (google.cloud.automl.v1.ITextSentimentModelMetadata|null);Model textSentimentModelMetadata.
translationModelMetadata
public translationModelMetadata?: (google.cloud.automl.v1.ITranslationModelMetadata|null);Model translationModelMetadata.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Model updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.automl.v1.IModel): google.cloud.automl.v1.Model;Creates a new Model instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IModel
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Model | Model instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.automl.v1.Model;Decodes a Model message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Model | Model |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.automl.v1.Model;Decodes a Model message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Model | Model |
encode(message, writer)
public static encode(message: google.cloud.automl.v1.IModel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Model message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IModel
Model message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.automl.v1.IModel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Model message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IModel
Model message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.automl.v1.Model;Creates a Model message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Model | Model |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Model
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Model to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.automl.v1.Model, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Model message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Model
Model |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Model message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|