Class: Google::Cloud::Dialogflow::V2::ConversationModel

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation_model.rb

Overview

Represents a conversation model.

Defined Under Namespace

Modules: ModelType, State

Instance Attribute Summary collapse

Instance Attribute Details

#article_suggestion_model_metadata::Google::Cloud::Dialogflow::V2::ArticleSuggestionModelMetadata

Returns Metadata for article suggestion models.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#create_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. Creation time of this model.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#datasets::Array<::Google::Cloud::Dialogflow::V2::InputDataset>

Returns Required. Datasets used to create model.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#display_name::String

Returns Required. The display name of the model. At most 64 bytes long.

Returns:

  • (::String)

    Required. The display name of the model. At most 64 bytes long.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#language_code::String

Returns Language code for the conversation model. If not specified, the language is en-US. Language at ConversationModel should be set for all non en-us languages. This should be a BCP-47 language tag. Example: "en-US".

Returns:

  • (::String)

    Language code for the conversation model. If not specified, the language is en-US. Language at ConversationModel should be set for all non en-us languages. This should be a BCP-47 language tag. Example: "en-US".



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#name::String

Returns ConversationModel resource name. Format: projects/<Project ID>/conversationModels/<Conversation Model ID>.

Returns:

  • (::String)

    ConversationModel resource name. Format: projects/<Project ID>/conversationModels/<Conversation Model ID>



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#satisfies_pzi::Boolean (readonly)

Returns Output only. A read only boolean field reflecting Zone Isolation status of the model.

Returns:

  • (::Boolean)

    Output only. A read only boolean field reflecting Zone Isolation status of the model.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#satisfies_pzs::Boolean (readonly)

Returns Output only. A read only boolean field reflecting Zone Separation status of the model.

Returns:

  • (::Boolean)

    Output only. A read only boolean field reflecting Zone Separation status of the model.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#smart_reply_model_metadata::Google::Cloud::Dialogflow::V2::SmartReplyModelMetadata

Returns Metadata for smart reply models.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end

#state::Google::Cloud::Dialogflow::V2::ConversationModel::State (readonly)

Returns Output only. State of the model. A model can only serve prediction requests after it gets deployed.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_model.rb', line 63

class ConversationModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the model.
  module State
    # Should not be used, an un-set enum has this value by default.
    STATE_UNSPECIFIED = 0

    # Model being created.
    CREATING = 1

    # Model is not deployed but ready to deploy.
    UNDEPLOYED = 2

    # Model is deploying.
    DEPLOYING = 3

    # Model is deployed and ready to use.
    DEPLOYED = 4

    # Model is undeploying.
    UNDEPLOYING = 5

    # Model is deleting.
    DELETING = 6

    # Model is in error state. Not ready to deploy and use.
    FAILED = 7

    # Model is being created but the training has not started,
    # The model may remain in this state until there is enough capacity to
    # start training.
    PENDING = 8
  end

  # Model type.
  module ModelType
    # ModelType unspecified.
    MODEL_TYPE_UNSPECIFIED = 0

    # ModelType smart reply dual encoder model.
    SMART_REPLY_DUAL_ENCODER_MODEL = 2

    # ModelType smart reply bert model.
    SMART_REPLY_BERT_MODEL = 6
  end
end