Class: Google::Cloud::Dialogflow::V2::SessionEntityTypesClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::SessionEntityTypesClient
- Defined in:
- lib/google/cloud/dialogflow/v2/session_entity_types_client.rb
Overview
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level.
Session entity methods do not work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
For more information about entity types, see the Dialogflow documentation.
Constant Summary collapse
- SERVICE_ADDRESS =
The default address of the service.
"dialogflow.googleapis.com".freeze
- DEFAULT_SERVICE_PORT =
The default port of the service.
443
- GRPC_INTERCEPTORS =
The default set of gRPC interceptors.
[]
- DEFAULT_TIMEOUT =
30
- ALL_SCOPES =
The scopes needed to make gRPC calls to all of the methods defined in this service.
[ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ].freeze
Class Method Summary collapse
-
.session_entity_type_path(project, session, entity_type) ⇒ String
Returns a fully-qualified session_entity_type resource name string.
-
.session_path(project, session) ⇒ String
Returns a fully-qualified session resource name string.
Instance Method Summary collapse
-
#create_session_entity_type(parent, session_entity_type, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType
Creates a session entity type.
-
#delete_session_entity_type(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified session entity type.
-
#get_session_entity_type(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType
Retrieves the specified session entity type.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ SessionEntityTypesClient
constructor
A new instance of SessionEntityTypesClient.
-
#list_session_entity_types(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>
Returns the list of all session entity types in the specified session.
-
#update_session_entity_type(session_entity_type, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType
Updates the specified session entity type.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ SessionEntityTypesClient
Returns a new instance of SessionEntityTypesClient.
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 157 def initialize \ credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/cloud/dialogflow/v2/session_entity_type_services_pb" credentials ||= Google::Cloud::Dialogflow::V2::Credentials.default if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Dialogflow::V2::Credentials.new(credentials).updater_proc end if credentials.is_a?(GRPC::Core::Channel) channel = credentials end if credentials.is_a?(GRPC::Core::ChannelCredentials) chan_creds = credentials end if credentials.is_a?(Proc) updater_proc = credentials end if credentials.is_a?(Google::Auth::Credentials) updater_proc = credentials.updater_proc end package_version = Google::Cloud::Dialogflow::VERSION google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } headers.merge!() unless .nil? client_config_file = Pathname.new(__dir__).join( "session_entity_types_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.cloud.dialogflow.v2.SessionEntityTypes", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, page_descriptors: PAGE_DESCRIPTORS, errors: Google::Gax::Grpc::API_ERRORS, metadata: headers ) end # Allow overriding the service path/port in subclasses. service_path = service_address || self.class::SERVICE_ADDRESS port = service_port || self.class::DEFAULT_SERVICE_PORT interceptors = self.class::GRPC_INTERCEPTORS @session_entity_types_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, interceptors: interceptors, &Google::Cloud::Dialogflow::V2::SessionEntityTypes::Stub.method(:new) ) @list_session_entity_types = Google::Gax.create_api_call( @session_entity_types_stub.method(:list_session_entity_types), defaults["list_session_entity_types"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @get_session_entity_type = Google::Gax.create_api_call( @session_entity_types_stub.method(:get_session_entity_type), defaults["get_session_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'name' => request.name} end ) @create_session_entity_type = Google::Gax.create_api_call( @session_entity_types_stub.method(:create_session_entity_type), defaults["create_session_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @update_session_entity_type = Google::Gax.create_api_call( @session_entity_types_stub.method(:update_session_entity_type), defaults["update_session_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'session_entity_type.name' => request.session_entity_type.name} end ) @delete_session_entity_type = Google::Gax.create_api_call( @session_entity_types_stub.method(:delete_session_entity_type), defaults["delete_session_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'name' => request.name} end ) end |
Class Method Details
.session_entity_type_path(project, session, entity_type) ⇒ String
Returns a fully-qualified session_entity_type resource name string.
116 117 118 119 120 121 122 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 116 def self.session_entity_type_path project, session, entity_type SESSION_ENTITY_TYPE_PATH_TEMPLATE.render( :"project" => project, :"session" => session, :"entity_type" => entity_type ) end |
.session_path(project, session) ⇒ String
Returns a fully-qualified session resource name string.
104 105 106 107 108 109 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 104 def self.session_path project, session SESSION_PATH_TEMPLATE.render( :"project" => project, :"session" => session ) end |
Instance Method Details
#create_session_entity_type(parent, session_entity_type, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType
Creates a session entity type.
If the specified session entity type already exists, overrides the session entity type.
This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
406 407 408 409 410 411 412 413 414 415 416 417 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 406 def create_session_entity_type \ parent, session_entity_type, options: nil, &block req = { parent: parent, session_entity_type: session_entity_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest) @create_session_entity_type.call(req, , &block) end |
#delete_session_entity_type(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified session entity type.
This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 489 def delete_session_entity_type \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest) @delete_session_entity_type.call(req, , &block) nil end |
#get_session_entity_type(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType
Retrieves the specified session entity type.
This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
361 362 363 364 365 366 367 368 369 370 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 361 def get_session_entity_type \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest) @get_session_entity_type.call(req, , &block) end |
#list_session_entity_types(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>
Returns the list of all session entity types in the specified session.
This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 323 def list_session_entity_types \ parent, page_size: nil, options: nil, &block req = { parent: parent, page_size: page_size }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest) @list_session_entity_types.call(req, , &block) end |
#update_session_entity_type(session_entity_type, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType
Updates the specified session entity type.
This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 452 def update_session_entity_type \ session_entity_type, update_mask: nil, options: nil, &block req = { session_entity_type: session_entity_type, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest) @update_session_entity_type.call(req, , &block) end |