Model

google.cloud.retail.v2. Model

Represents a Model.

Constructor

new Model(propertiesopt)

Constructs a new Model.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2.IModel <optional>

Properties to set
Implements:
  • IModel

Classes

FrequentlyBoughtTogetherFeaturesConfig
ModelFeaturesConfig
ServingConfigList

Members

createTime

Model createTime.

dataState

Model dataState.

displayName

Model displayName.

filteringOption

Model filteringOption.

lastTuneTime

Model lastTuneTime.

modelFeaturesConfig

Model modelFeaturesConfig.

name

Model name.

optimizationObjective

Model optimizationObjective.

periodicTuningState

Model periodicTuningState.

servingConfigLists

Model servingConfigLists.

servingState

Model servingState.

trainingState

Model trainingState.

tuningOperation

Model tuningOperation.

type

Model type.

updateTime

Model updateTime.

ContextProductsType

ContextProductsType enum.

Properties:
Name Type Description
CONTEXT_PRODUCTS_TYPE_UNSPECIFIED number

CONTEXT_PRODUCTS_TYPE_UNSPECIFIED value
SINGLE_CONTEXT_PRODUCT number

SINGLE_CONTEXT_PRODUCT value
MULTIPLE_CONTEXT_PRODUCTS number

MULTIPLE_CONTEXT_PRODUCTS value

DataState

DataState enum.

Properties:
Name Type Description
DATA_STATE_UNSPECIFIED number

DATA_STATE_UNSPECIFIED value
DATA_OK number

DATA_OK value
DATA_ERROR number

DATA_ERROR value

PeriodicTuningState

PeriodicTuningState enum.

Properties:
Name Type Description
PERIODIC_TUNING_STATE_UNSPECIFIED number

PERIODIC_TUNING_STATE_UNSPECIFIED value
PERIODIC_TUNING_DISABLED number

PERIODIC_TUNING_DISABLED value
ALL_TUNING_DISABLED number

ALL_TUNING_DISABLED value
PERIODIC_TUNING_ENABLED number

PERIODIC_TUNING_ENABLED value

ServingState

ServingState enum.

Properties:
Name Type Description
SERVING_STATE_UNSPECIFIED number

SERVING_STATE_UNSPECIFIED value
INACTIVE number

INACTIVE value
ACTIVE number

ACTIVE value
TUNED number

TUNED value

TrainingState

TrainingState enum.

Properties:
Name Type Description
TRAINING_STATE_UNSPECIFIED number

TRAINING_STATE_UNSPECIFIED value
PAUSED number

PAUSED value
TRAINING number

TRAINING value

Methods

toJSON() → {Object.<string, *>}

Converts this Model to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.retail.v2.Model}

Creates a new Model instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2.IModel <optional>

Properties to set
Returns:
Type Description
google.cloud.retail.v2.Model

Model instance

(static) decode(reader, lengthopt) → {google.cloud.retail.v2.Model}

Decodes a Model message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.retail.v2.Model

Model
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.retail.v2.Model}

Decodes a Model message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.retail.v2.Model

Model
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Model message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2.IModel

Model message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Model message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2.IModel

Model message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.retail.v2.Model}

Creates a Model message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.retail.v2.Model

Model

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Model

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Model message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2.Model

Model
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Model message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not