class Google::Cloud::Dialogflow::V2::KnowledgeBases::Client

Client for the KnowledgeBases service.

Service for managing {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBases}.

Attributes

knowledge_bases_stub[R]

@private

Public Class Methods

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

Configure the KnowledgeBases Client class.

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

@example

# Modify the configuration for all KnowledgeBases clients
::Google::Cloud::Dialogflow::V2::KnowledgeBases::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/knowledge_bases/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 KnowledgeBases client object.

@example

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

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

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

# File lib/google/cloud/dialogflow/v2/knowledge_bases/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/knowledge_base_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

  @knowledge_bases_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::V2::KnowledgeBases::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 KnowledgeBases 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::KnowledgeBases::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/knowledge_bases/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
create_knowledge_base(request, options = nil) { |response, operation| ... } click to toggle source

Creates a knowledge base.

@overload create_knowledge_base(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::CreateKnowledgeBaseRequest, ::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_knowledge_base(parent: nil, knowledge_base: nil)

Pass arguments to `create_knowledge_base` 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 project to create a knowledge base for.
  Format: `projects/<Project ID>/locations/<Location ID>`.
@param knowledge_base [::Google::Cloud::Dialogflow::V2::KnowledgeBase, ::Hash]
  Required. The knowledge base to create.

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

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

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

# File lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb, line 329
def create_knowledge_base request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateKnowledgeBaseRequest

  # 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_knowledge_base.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_knowledge_base.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_knowledge_base.retry_policy

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

  @knowledge_bases_stub.call_rpc :create_knowledge_base, 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
delete_knowledge_base(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified knowledge base.

@overload delete_knowledge_base(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::DeleteKnowledgeBaseRequest, ::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_knowledge_base(name: nil, force: nil)

Pass arguments to `delete_knowledge_base` 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 knowledge base to delete.
  Format: `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>`.
@param force [::Boolean]
  Optional. Force deletes the knowledge base. When set to true, any documents
  in the knowledge base are also deleted.

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

@return [::Google::Protobuf::Empty]

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

# File lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb, line 402
def delete_knowledge_base request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteKnowledgeBaseRequest

  # 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_knowledge_base.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_knowledge_base.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_knowledge_base.retry_policy

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

  @knowledge_bases_stub.call_rpc :delete_knowledge_base, 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
get_knowledge_base(request, options = nil) { |response, operation| ... } click to toggle source

Retrieves the specified knowledge base.

@overload get_knowledge_base(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::GetKnowledgeBaseRequest, ::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_knowledge_base(name: nil)

Pass arguments to `get_knowledge_base` 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 knowledge base to retrieve.
  Format `projects/<Project ID>/locations/<Location
  ID>/knowledgeBases/<Knowledge Base ID>`.

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

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

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

# File lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb, line 258
def get_knowledge_base request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetKnowledgeBaseRequest

  # 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_knowledge_base.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_knowledge_base.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_knowledge_base.retry_policy

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

  @knowledge_bases_stub.call_rpc :get_knowledge_base, 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_knowledge_bases(request, options = nil) { |response, operation| ... } click to toggle source

Returns the list of all knowledge bases of the specified agent.

@overload list_knowledge_bases(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest, ::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_knowledge_bases(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_knowledge_bases` 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 project to list of knowledge bases for.
  Format: `projects/<Project ID>/locations/<Location 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::KnowledgeBase>] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb, line 187
def list_knowledge_bases request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest

  # 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_knowledge_bases.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_knowledge_bases.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_knowledge_bases.retry_policy

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

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

Updates the specified knowledge base.

@overload update_knowledge_base(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::UpdateKnowledgeBaseRequest, ::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_knowledge_base(knowledge_base: nil, update_mask: nil)

Pass arguments to `update_knowledge_base` 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 knowledge_base [::Google::Cloud::Dialogflow::V2::KnowledgeBase, ::Hash]
  Required. The knowledge base 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 [::Google::Cloud::Dialogflow::V2::KnowledgeBase] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb, line 474
def update_knowledge_base request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateKnowledgeBaseRequest

  # 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_knowledge_base.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 = {
    "knowledge_base.name" => request.knowledge_base.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_knowledge_base.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_knowledge_base.retry_policy

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

  @knowledge_bases_stub.call_rpc :update_knowledge_base, 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