class Google::Cloud::Dialogflow::V2::Documents::Client

Client for the Documents service.

Service for managing knowledge {::Google::Cloud::Dialogflow::V2::Document Documents}.

Attributes

documents_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::Dialogflow::V2::Documents::Operations]

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Documents Client class.

See {::Google::Cloud::Dialogflow::V2::Documents::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Documents clients
::Google::Cloud::Dialogflow::V2::Documents::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 56
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
new() { |config| ... } click to toggle source

Create a new Documents client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Documents client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 114
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 endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @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

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::Dialogflow::V2::Documents::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
create_document(request, options = nil) { |response, operation| ... } click to toggle source

Creates a new document.

This method is a [long-running operation](cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

  • `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}

  • `response`: {::Google::Cloud::Dialogflow::V2::Document Document}

@overload create_document(request, options = nil)

Pass arguments to `create_document` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::CreateDocumentRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::CreateDocumentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_document(parent: nil, document: nil)

Pass arguments to `create_document` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The knowledge base to create a document for.
  Format: `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>`.
@param document [::Google::Cloud::Dialogflow::V2::Document, ::Hash]
  Required. The document to create.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 350
def create_document request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_document.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_document.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_document.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @documents_stub.call_rpc :create_document, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: 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) { |response, operation| ... } click to toggle source

Deletes the specified document.

This method is a [long-running operation](cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

@overload delete_document(request, options = nil)

Pass arguments to `delete_document` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::DeleteDocumentRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::DeleteDocumentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_document(name: nil)

Pass arguments to `delete_document` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the document to delete.
  Format: `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 429
def delete_document request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_document.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_document.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_document.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @documents_stub.call_rpc :delete_document, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: 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) { |response, operation| ... } click to toggle source

Retrieves the specified document.

@overload get_document(request, options = nil)

Pass arguments to `get_document` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::GetDocumentRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::GetDocumentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_document(name: nil)

Pass arguments to `get_document` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the document to retrieve.
  Format `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::V2::Document] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::V2::Document]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 271
def get_document request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_document.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_document.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_document.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @documents_stub.call_rpc :get_document, request, options: 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) { |response, operation| ... } click to toggle source

Returns the list of all documents of the knowledge base.

@overload list_documents(request, options = nil)

Pass arguments to `list_documents` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::ListDocumentsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::ListDocumentsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_documents(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_documents` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The knowledge base to list all documents for.
  Format: `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>`.
@param page_size [::Integer]
  The maximum number of items to return in a single page. By
  default 10 and at most 100.
@param page_token [::String]
  The next_page_token value returned from a previous list request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Document>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Document>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 200
def list_documents request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_documents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_documents.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_documents.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @documents_stub.call_rpc :list_documents, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @documents_stub, :list_documents, request, response, operation, options
    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) { |response, operation| ... } click to toggle source

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.

This method is a [long-running operation](cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

  • `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}

  • `response`: {::Google::Cloud::Dialogflow::V2::Document Document}

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

@overload reload_document(request, options = nil)

Pass arguments to `reload_document` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::ReloadDocumentRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::ReloadDocumentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload reload_document(name: nil, content_uri: nil)

Pass arguments to `reload_document` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the document to reload.
  Format: `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
@param content_uri [::String]
  Optional. The path of gcs source file for reloading document content. For now,
  only gcs uri is supported.

  For documents stored in Google Cloud Storage, these URIs must have
  the form `gs://<bucket-name>/<object-name>`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 599
def reload_document request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reload_document.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reload_document.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reload_document.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @documents_stub.call_rpc :reload_document, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: 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) { |response, operation| ... } click to toggle source

Updates the specified document.

This method is a [long-running operation](cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

  • `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}

  • `response`: {::Google::Cloud::Dialogflow::V2::Document Document}

@overload update_document(request, options = nil)

Pass arguments to `update_document` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::UpdateDocumentRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::UpdateDocumentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_document(document: nil, update_mask: nil)

Pass arguments to `update_document` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param document [::Google::Cloud::Dialogflow::V2::Document, ::Hash]
  Required. The document to update.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Optional. Not specified means `update all`.
  Currently, only `display_name` can be updated, an InvalidArgument will be
  returned for attempting to update other fields.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/documents/client.rb, line 509
def update_document request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_document.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_document.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_document.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @documents_stub.call_rpc :update_document, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end