Class: Google::Cloud::Dialogflow::V2::Documents::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::Documents::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dialogflow/v2/documents/client.rb
Overview
Client for the Documents service.
Service for managing knowledge Documents.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::Dialogflow::V2::Documents::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Documents Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Documents Client instance.
-
#create_document(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a new document.
-
#delete_document(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes the specified document.
-
#get_document(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::Document
Retrieves the specified document.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Documents client object.
-
#list_documents(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Document>
Returns the list of all documents of the knowledge base.
-
#reload_document(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Reloads the specified document from its specified source, content_uri or content.
-
#update_document(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the specified document.
Methods included from Paths
#document_path, #knowledge_base_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Documents client object.
Examples
To create a new Documents client with the default configuration:
client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new
To create a new Documents client with a custom configuration:
client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
config.timeout = 10.0
end
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 122 def initialize # 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 "gapic/grpc" require "google/cloud/dialogflow/v2/document_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @documents_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dialogflow::V2::Documents::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::Dialogflow::V2::Documents::Operations (readonly)
Get the associated client for long-running operations.
169 170 171 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 169 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the Documents Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all Documents clients:
::Google::Cloud::Dialogflow::V2::Documents::Client.configure do |config|
config.timeout = 10.0
end
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "V2"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the Documents Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
97 98 99 100 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 97 def configure yield @config if block_given? @config end |
#create_document(request, options = nil) ⇒ ::Gapic::Operation #create_document(parent: nil, document: nil) ⇒ ::Gapic::Operation
Creates a new document.
Operation
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 351 def create_document request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateDocumentRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_document..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_document.timeout, metadata: , retry_policy: @config.rpcs.create_document.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @documents_stub.call_rpc :create_document, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_document(request, options = nil) ⇒ ::Gapic::Operation #delete_document(name: nil) ⇒ ::Gapic::Operation
Deletes the specified document.
Operation
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 423 def delete_document request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteDocumentRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_document..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_document.timeout, metadata: , retry_policy: @config.rpcs.delete_document.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @documents_stub.call_rpc :delete_document, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_document(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Document #get_document(name: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Document
Retrieves the specified document.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 278 def get_document request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetDocumentRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_document..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_document.timeout, metadata: , retry_policy: @config.rpcs.get_document.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @documents_stub.call_rpc :get_document, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_documents(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Document> #list_documents(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Document>
Returns the list of all documents of the knowledge base.
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 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 209 def list_documents request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListDocumentsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_documents..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_documents.timeout, metadata: , retry_policy: @config.rpcs.list_documents.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @documents_stub.call_rpc :list_documents, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @documents_stub, :list_documents, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#reload_document(request, options = nil) ⇒ ::Gapic::Operation #reload_document(name: nil, content_uri: nil) ⇒ ::Gapic::Operation
Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
Operation
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 581 def reload_document request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ReloadDocumentRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.reload_document..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.reload_document.timeout, metadata: , retry_policy: @config.rpcs.reload_document.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @documents_stub.call_rpc :reload_document, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#update_document(request, options = nil) ⇒ ::Gapic::Operation #update_document(document: nil, update_mask: nil) ⇒ ::Gapic::Operation
Updates the specified document.
Operation
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 |
# File 'lib/google/cloud/dialogflow/v2/documents/client.rb', line 497 def update_document request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateDocumentRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_document..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "document.name" => request.document.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_document.timeout, metadata: , retry_policy: @config.rpcs.update_document.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @documents_stub.call_rpc :update_document, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |