Class: Google::Cloud::Dialogflow::V2::ContextsClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::ContextsClient
- Defined in:
- lib/google/cloud/dialogflow/v2/contexts_client.rb
Overview
A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on.
You can include contexts as input parameters of a
DetectIntent (or
StreamingDetectIntent) request,
or as output contexts included in the returned intent.
Contexts expire when an intent is matched, after the number of DetectIntent
requests specified by the lifespan_count
parameter, or after 20 minutes
if no intents are matched for a DetectIntent
request.
For more information about contexts, 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
-
.context_path(project, session, context) ⇒ String
Returns a fully-qualified context resource name string.
-
.session_path(project, session) ⇒ String
Returns a fully-qualified session resource name string.
Instance Method Summary collapse
-
#create_context(parent, context, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context
Creates a context.
-
#delete_all_contexts(parent, options: nil) {|result, operation| ... } ⇒ Object
Deletes all active contexts in the specified session.
-
#delete_context(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified context.
-
#get_context(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context
Retrieves the specified context.
-
#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: "") ⇒ ContextsClient
constructor
A new instance of ContextsClient.
-
#list_contexts(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Context>
Returns the list of all contexts in the specified session.
-
#update_context(context, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context
Updates the specified context.
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: "") ⇒ ContextsClient
Returns a new instance of ContextsClient.
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 274 275 276 277 278 279 280 281 282 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 158 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/context_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( "contexts_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.cloud.dialogflow.v2.Contexts", 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 @contexts_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::Contexts::Stub.method(:new) ) @list_contexts = Google::Gax.create_api_call( @contexts_stub.method(:list_contexts), defaults["list_contexts"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @get_context = Google::Gax.create_api_call( @contexts_stub.method(:get_context), defaults["get_context"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'name' => request.name} end ) @create_context = Google::Gax.create_api_call( @contexts_stub.method(:create_context), defaults["create_context"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @update_context = Google::Gax.create_api_call( @contexts_stub.method(:update_context), defaults["update_context"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'context.name' => request.context.name} end ) @delete_context = Google::Gax.create_api_call( @contexts_stub.method(:delete_context), defaults["delete_context"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'name' => request.name} end ) @delete_all_contexts = Google::Gax.create_api_call( @contexts_stub.method(:delete_all_contexts), defaults["delete_all_contexts"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) end |
Class Method Details
.context_path(project, session, context) ⇒ String
Returns a fully-qualified context resource name string.
106 107 108 109 110 111 112 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 106 def self.context_path project, session, context CONTEXT_PATH_TEMPLATE.render( :"project" => project, :"session" => session, :"context" => context ) end |
.session_path(project, session) ⇒ String
Returns a fully-qualified session resource name string.
118 119 120 121 122 123 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 118 def self.session_path project, session SESSION_PATH_TEMPLATE.render( :"project" => project, :"session" => session ) end |
Instance Method Details
#create_context(parent, context, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context
Creates a context.
If the specified context already exists, overrides the context.
401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 401 def create_context \ parent, context, options: nil, &block req = { parent: parent, context: context }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateContextRequest) @create_context.call(req, , &block) end |
#delete_all_contexts(parent, options: nil) {|result, operation| ... } ⇒ Object
Deletes all active contexts in the specified session.
504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 504 def delete_all_contexts \ parent, options: nil, &block req = { parent: parent }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteAllContextsRequest) @delete_all_contexts.call(req, , &block) nil end |
#delete_context(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified context.
473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 473 def delete_context \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteContextRequest) @delete_context.call(req, , &block) nil end |
#get_context(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context
Retrieves the specified context.
361 362 363 364 365 366 367 368 369 370 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 361 def get_context \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetContextRequest) @get_context.call(req, , &block) end |
#list_contexts(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Context>
Returns the list of all contexts in the specified session.
328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 328 def list_contexts \ 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::ListContextsRequest) @list_contexts.call(req, , &block) end |
#update_context(context, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context
Updates the specified context.
441 442 443 444 445 446 447 448 449 450 451 452 |
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 441 def update_context \ context, update_mask: nil, options: nil, &block req = { context: context, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateContextRequest) @update_context.call(req, , &block) end |