class Google::Cloud::Dialogflow::CX::V3::Flows::Client
Service
for managing {::Google::Cloud::Dialogflow::CX::V3::Flow Flows}.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::Dialogflow::CX::V3::Flows::Operations]
Public Class Methods
Configure the Flows
Client
class.
See {::Google::Cloud::Dialogflow::CX::V3::Flows::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Flows clients ::Google::Cloud::Dialogflow::CX::V3::Flows::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/cx/v3/flows/client.rb, line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"] 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
Create a new Flows
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Dialogflow::CX::V3::Flows::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dialogflow::CX::V3::Flows::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Flows
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 115 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/cx/v3/flow_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 @flows_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dialogflow::CX::V3::Flows::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the Flows
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::CX::V3::Flows::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/cx/v3/flows/client.rb, line 94 def configure yield @config if block_given? @config end
Creates a flow in the specified agent.
Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).
@overload create_flow
(request, options = nil)
Pass arguments to `create_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::CreateFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::CreateFlowRequest, ::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_flow
(parent: nil, flow: nil, language_code: nil)
Pass arguments to `create_flow` 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 agent to create a flow for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. @param flow [::Google::Cloud::Dialogflow::CX::V3::Flow, ::Hash] Required. The flow to create. @param language_code [::String] The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Flow] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::CX::V3::Flow]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 214 def create_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CreateFlowRequest # 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_flow.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::CX::V3::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_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.create_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :create_flow, 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
Deletes a specified flow.
@overload delete_flow
(request, options = nil)
Pass arguments to `delete_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest, ::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_flow
(name: nil, force: nil)
Pass arguments to `delete_flow` 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 flow to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`. @param force [::Boolean] This field has no effect for flows with no incoming transitions. For flows with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. [Target flow][EventHandler.target_flow] in event handlers or [Target flow][TransitionRoute.target_flow] in transition routes that point to this flow will be cleared).
@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/cx/v3/flows/client.rb, line 295 def delete_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest # 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_flow.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::CX::V3::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_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :delete_flow, 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
Exports the specified flow to a binary file.
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
@overload export_flow
(request, options = nil)
Pass arguments to `export_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest, ::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 export_flow
(name: nil, flow_uri: nil, include_referenced_flows: nil)
Pass arguments to `export_flow` 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 flow to export. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`. @param flow_uri [::String] Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized flow is returned inline. @param include_referenced_flows [::Boolean] Optional. Whether to export flows referenced by the specified flow.
@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/cx/v3/flows/client.rb, line 941 def export_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest # 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.export_flow.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::CX::V3::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.export_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.export_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :export_flow, 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
Retrieves the specified flow.
@overload get_flow
(request, options = nil)
Pass arguments to `get_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::GetFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::GetFlowRequest, ::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_flow
(name: nil, language_code: nil)
Pass arguments to `get_flow` 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 flow to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`. @param language_code [::String] The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Flow] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::CX::V3::Flow]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 468 def get_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetFlowRequest # 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_flow.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::CX::V3::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_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.get_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :get_flow, 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
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
@overload get_flow_validation_result
(request, options = nil)
Pass arguments to `get_flow_validation_result` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::GetFlowValidationResultRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::GetFlowValidationResultRequest, ::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_flow_validation_result
(name: nil, language_code: nil)
Pass arguments to `get_flow_validation_result` 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 flow name. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/validationResult`. @param language_code [::String] If not specified, the agent's default language is used.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 779 def get_flow_validation_result request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetFlowValidationResultRequest # 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_flow_validation_result.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::CX::V3::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_flow_validation_result.timeout, metadata: metadata, retry_policy: @config.rpcs.get_flow_validation_result.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :get_flow_validation_result, 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
Imports the specified flow to the specified agent from a binary file.
Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).
@overload import_flow
(request, options = nil)
Pass arguments to `import_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest, ::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 import_flow
(parent: nil, flow_uri: nil, flow_content: nil, import_option: nil)
Pass arguments to `import_flow` 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 agent to import the flow into. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. @param flow_uri [::String] The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import flow from. The format of this URI must be `gs://<bucket-name>/<object-name>`. @param flow_content [::String] Uncompressed raw byte content for flow. @param import_option [::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest::ImportOption] Flow import mode. If not specified, `KEEP` is assumed.
@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/cx/v3/flows/client.rb, line 860 def import_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest # 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.import_flow.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::CX::V3::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.import_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.import_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :import_flow, 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
Returns the list of all flows in the specified agent.
@overload list_flows
(request, options = nil)
Pass arguments to `list_flows` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::ListFlowsRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::ListFlowsRequest, ::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_flows
(parent: nil, page_size: nil, page_token: nil, language_code: nil)
Pass arguments to `list_flows` 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 agent containing the flows. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. @param page_size [::Integer] The maximum number of items to return in a single page. By default 100 and at most 1000. @param page_token [::String] The next_page_token value returned from a previous list request. @param language_code [::String] The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Flow>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Flow>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 383 def list_flows request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListFlowsRequest # 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_flows.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::CX::V3::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_flows.timeout, metadata: metadata, retry_policy: @config.rpcs.list_flows.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :list_flows, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @flows_stub, :list_flows, 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
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).
@overload train_flow
(request, options = nil)
Pass arguments to `train_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::TrainFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::TrainFlowRequest, ::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 train_flow
(name: nil)
Pass arguments to `train_flow` 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 flow to train. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow 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/cx/v3/flows/client.rb, line 631 def train_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::TrainFlowRequest # 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.train_flow.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::CX::V3::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.train_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.train_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :train_flow, 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
Updates the specified flow.
Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).
@overload update_flow
(request, options = nil)
Pass arguments to `update_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::UpdateFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::UpdateFlowRequest, ::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_flow
(flow: nil, update_mask: nil, language_code: nil)
Pass arguments to `update_flow` 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 flow [::Google::Cloud::Dialogflow::CX::V3::Flow, ::Hash] Required. The flow to update. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] The mask to control which fields get updated. If the mask is not present, all fields will be updated. @param language_code [::String] The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Flow] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::CX::V3::Flow]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 556 def update_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::UpdateFlowRequest # 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_flow.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::CX::V3::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "flow.name" => request.flow.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_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.update_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :update_flow, 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
Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.
@overload validate_flow
(request, options = nil)
Pass arguments to `validate_flow` via a request object, either of type {::Google::Cloud::Dialogflow::CX::V3::ValidateFlowRequest} or an equivalent Hash. @param request [::Google::Cloud::Dialogflow::CX::V3::ValidateFlowRequest, ::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 validate_flow
(name: nil, language_code: nil)
Pass arguments to `validate_flow` 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 flow to validate. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`. @param language_code [::String] If not specified, the agent's default language is used.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dialogflow/cx/v3/flows/client.rb, line 706 def validate_flow request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ValidateFlowRequest # 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.validate_flow.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::CX::V3::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.validate_flow.timeout, metadata: metadata, retry_policy: @config.rpcs.validate_flow.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @flows_stub.call_rpc :validate_flow, 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