chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google/apis/dialogflow_v2/service.rb

1398 lines
90 KiB
Ruby
Raw Normal View History

Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DialogflowV2
# Dialogflow API
#
Autogenerated update (2018-10-17) Delete: - serviceuser_v1 Update: - appengine_v1 - appengine_v1alpha - appengine_v1beta - appengine_v1beta4 - appengine_v1beta5 - dialogflow_v2 - dns_v1beta2 - jobs_v3 - script_v1 - toolresults_v1beta3
2018-10-17 00:36:31 +00:00
# Builds conversational interfaces (for example, chatbots, and voice-powered
# apps and devices).
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
#
# @example
# require 'google/apis/dialogflow_v2'
#
# Dialogflow = Google::Apis::DialogflowV2 # Alias the module
# service = Dialogflow::DialogflowService.new
#
# @see https://cloud.google.com/dialogflow-enterprise/
class DialogflowService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://dialogflow.googleapis.com/', '')
@batch_path = 'batch'
end
# Retrieves the specified agent.
# @param [String] parent
# Required. The project that the agent to fetch is associated with.
# Format: `projects/<Project ID>`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_agent(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+parent}/agent', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Exports the specified agent to a ZIP file.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: ExportAgentResponse>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The project that the agent to export is associated with.
# Format: `projects/<Project ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportAgentRequest] google_cloud_dialogflow_v2_export_agent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def export_project_agent(parent, google_cloud_dialogflow_v2_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/agent:export', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportAgentRequest::Representation
command.request_object = google_cloud_dialogflow_v2_export_agent_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Imports the specified agent from a ZIP file.
# Uploads new intents and entity types without deleting the existing ones.
# Intents and entity types with the same name are replaced with the new
# versions from ImportAgentRequest.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: google.protobuf.Empty>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The project that the agent to import is associated with.
# Format: `projects/<Project ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportAgentRequest] google_cloud_dialogflow_v2_import_agent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def import_project_agent(parent, google_cloud_dialogflow_v2_import_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/agent:import', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportAgentRequest::Representation
command.request_object = google_cloud_dialogflow_v2_import_agent_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Restores the specified agent from a ZIP file.
# Replaces the current agent version with a new one. All the intents and
# entity types in the older version are deleted.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: google.protobuf.Empty>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The project that the agent to restore is associated with.
# Format: `projects/<Project ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2RestoreAgentRequest] google_cloud_dialogflow_v2_restore_agent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def restore_project_agent(parent, google_cloud_dialogflow_v2_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/agent:restore', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2RestoreAgentRequest::Representation
command.request_object = google_cloud_dialogflow_v2_restore_agent_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the list of agents.
# Since there is at most one conversational agent per project, this method is
# useful primarily for listing all agents across projects the caller has
# access to. One can achieve that with a wildcard project collection id "-".
# Refer to [List
# Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-
# collections).
# @param [String] parent
# Required. The project to list agents from.
# Format: `projects/<Project ID or '-'>`.
# @param [Fixnum] page_size
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param [String] page_token
# Optional. The next_page_token value returned from a previous list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_project_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+parent}/agent:search', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Trains the specified agent.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: google.protobuf.Empty>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The project that the agent to train is associated with.
# Format: `projects/<Project ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TrainAgentRequest] google_cloud_dialogflow_v2_train_agent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def train_project_agent(parent, google_cloud_dialogflow_v2_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/agent:train', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TrainAgentRequest::Representation
command.request_object = google_cloud_dialogflow_v2_train_agent_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes entity types in the specified agent.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: google.protobuf.Empty>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The name of the agent to delete all entities types for. Format:
# `projects/<Project ID>/agent`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest] google_cloud_dialogflow_v2_batch_delete_entity_types_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_entity_type_delete(parent, google_cloud_dialogflow_v2_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entityTypes:batchDelete', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_delete_entity_types_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates/Creates multiple entity types in the specified agent.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: BatchUpdateEntityTypesResponse>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The name of the agent to update or create entity types in.
# Format: `projects/<Project ID>/agent`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest] google_cloud_dialogflow_v2_batch_update_entity_types_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_entity_type_update(parent, google_cloud_dialogflow_v2_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entityTypes:batchUpdate', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_update_entity_types_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an entity type in the specified agent.
# @param [String] parent
# Required. The agent to create a entity type for.
# Format: `projects/<Project ID>/agent`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] google_cloud_dialogflow_v2_entity_type_object
# @param [String] language_code
# Optional. The language of entity synonyms defined in `entity_type`. If not
# specified, the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_agent_entity_type(parent, google_cloud_dialogflow_v2_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entityTypes', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
command.request_object = google_cloud_dialogflow_v2_entity_type_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType
command.params['parent'] = parent unless parent.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified entity type.
# @param [String] name
# Required. The name of the entity type to delete.
# Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_agent_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified entity type.
# @param [String] name
# Required. The name of the entity type.
# Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
# @param [String] language_code
# Optional. The language to retrieve entity synonyms for. If not specified,
# the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType
command.params['name'] = name unless name.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the list of all entity types in the specified agent.
# @param [String] parent
# Required. The agent to list all entity types from.
# Format: `projects/<Project ID>/agent`.
# @param [String] language_code
# Optional. The language to list entity synonyms for. If not specified,
# the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [Fixnum] page_size
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param [String] page_token
# Optional. The next_page_token value returned from a previous list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+parent}/entityTypes', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse
command.params['parent'] = parent unless parent.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified entity type.
# @param [String] name
Autogenerated update (2019-01-11) Update: - compute_alpha - compute_beta - compute_v1 - container_v1 - dialogflow_v2 - dns_v1 - dns_v1beta2 - dns_v2beta1 - doubleclickbidmanager_v1 - firestore_v1 - firestore_v1beta1 - fitness_v1 - jobs_v3p1beta1 - serviceconsumermanagement_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - slides_v1 - youtube_partner_v1
2019-01-11 00:36:34 +00:00
# The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] google_cloud_dialogflow_v2_entity_type_object
# @param [String] language_code
# Optional. The language of entity synonyms defined in `entity_type`. If not
# specified, the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [String] update_mask
# Optional. The mask to control which fields get updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_agent_entity_type(name, google_cloud_dialogflow_v2_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2/{+name}', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
command.request_object = google_cloud_dialogflow_v2_entity_type_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType
command.params['name'] = name unless name.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
Autogenerated update (2018-09-20) Update: - cloudkms_v1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - kgsearch_v1 - ml_v1 - people_v1 - testing_v1
2018-09-20 00:36:26 +00:00
# Creates multiple new entities in the specified entity type.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# Operation <response: google.protobuf.Empty>
# @param [String] parent
# Required. The name of the entity type to create entities in. Format:
# `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchCreateEntitiesRequest] google_cloud_dialogflow_v2_batch_create_entities_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_entity_type_entity_create(parent, google_cloud_dialogflow_v2_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entities:batchCreate', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchCreateEntitiesRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_create_entities_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes entities in the specified entity type.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: google.protobuf.Empty>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The name of the entity type to delete entries for. Format:
# `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntitiesRequest] google_cloud_dialogflow_v2_batch_delete_entities_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_entity_type_entity_delete(parent, google_cloud_dialogflow_v2_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entities:batchDelete', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntitiesRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_delete_entities_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
Autogenerated update (2018-09-20) Update: - cloudkms_v1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - kgsearch_v1 - ml_v1 - people_v1 - testing_v1
2018-09-20 00:36:26 +00:00
# Updates or creates multiple entities in the specified entity type. This
# method does not affect entities in the entity type that aren't explicitly
# specified in the request.
Autogenerated update (2019-01-16) Update: - alertcenter_v1beta1 - analytics_v3 - androidmanagement_v1 - cloudsearch_v1 - cloudtasks_v2beta3 - dialogflow_v2 - dialogflow_v2beta1 - firebasehosting_v1beta1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - script_v1 - servicenetworking_v1beta - speech_v1 - speech_v1p1beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1
2019-01-16 00:36:25 +00:00
# Operation <response: google.protobuf.Empty>
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
Autogenerated update (2018-09-20) Update: - cloudkms_v1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - kgsearch_v1 - ml_v1 - people_v1 - testing_v1
2018-09-20 00:36:26 +00:00
# Required. The name of the entity type to update or create entities in.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntitiesRequest] google_cloud_dialogflow_v2_batch_update_entities_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_entity_type_entity_update(parent, google_cloud_dialogflow_v2_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entities:batchUpdate', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntitiesRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_update_entities_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes intents in the specified agent.
# Operation <response: google.protobuf.Empty>
# @param [String] parent
# Required. The name of the agent to delete all entities types for. Format:
# `projects/<Project ID>/agent`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteIntentsRequest] google_cloud_dialogflow_v2_batch_delete_intents_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_intent_delete(parent, google_cloud_dialogflow_v2_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/intents:batchDelete', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteIntentsRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_delete_intents_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates/Creates multiple intents in the specified agent.
# Operation <response: BatchUpdateIntentsResponse>
# @param [String] parent
# Required. The name of the agent to update or create intents in.
# Format: `projects/<Project ID>/agent`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateIntentsRequest] google_cloud_dialogflow_v2_batch_update_intents_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_project_agent_intent_update(parent, google_cloud_dialogflow_v2_batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/intents:batchUpdate', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateIntentsRequest::Representation
command.request_object = google_cloud_dialogflow_v2_batch_update_intents_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an intent in the specified agent.
# @param [String] parent
# Required. The agent to create a intent for.
# Format: `projects/<Project ID>/agent`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] google_cloud_dialogflow_v2_intent_object
# @param [String] intent_view
# Optional. The resource view to apply to the returned intent.
# @param [String] language_code
# Optional. The language of training phrases, parameters and rich messages
# defined in `intent`. If not specified, the agent's default language is
# used. [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_agent_intent(parent, google_cloud_dialogflow_v2_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/intents', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
command.request_object = google_cloud_dialogflow_v2_intent_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
command.params['parent'] = parent unless parent.nil?
command.query['intentView'] = intent_view unless intent_view.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
Autogenerated update (2018-09-22) Update: - container_v1beta1 - dialogflow_v2 - jobs_v3 - serviceconsumermanagement_v1 - serviceusage_v1 - serviceusage_v1beta1
2018-09-22 00:36:46 +00:00
# Deletes the specified intent and its direct or indirect followup intents.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] name
Autogenerated update (2018-09-22) Update: - container_v1beta1 - dialogflow_v2 - jobs_v3 - serviceconsumermanagement_v1 - serviceusage_v1 - serviceusage_v1beta1
2018-09-22 00:36:46 +00:00
# Required. The name of the intent to delete. If this intent has direct or
# indirect followup intents, we also delete them.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_agent_intent(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified intent.
# @param [String] name
# Required. The name of the intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param [String] intent_view
# Optional. The resource view to apply to the returned intent.
# @param [String] language_code
# Optional. The language to retrieve training phrases, parameters and rich
# messages for. If not specified, the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_agent_intent(name, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
command.params['name'] = name unless name.nil?
command.query['intentView'] = intent_view unless intent_view.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the list of all intents in the specified agent.
# @param [String] parent
# Required. The agent to list all intents from.
# Format: `projects/<Project ID>/agent`.
# @param [String] intent_view
# Optional. The resource view to apply to the returned intent.
# @param [String] language_code
# Optional. The language to list training phrases, parameters and rich
# messages for. If not specified, the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent before they can be used.
# @param [Fixnum] page_size
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param [String] page_token
# Optional. The next_page_token value returned from a previous list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+parent}/intents', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['intentView'] = intent_view unless intent_view.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified intent.
# @param [String] name
# The unique identifier of this intent.
Autogenerated update (2019-01-11) Update: - compute_alpha - compute_beta - compute_v1 - container_v1 - dialogflow_v2 - dns_v1 - dns_v1beta2 - dns_v2beta1 - doubleclickbidmanager_v1 - firestore_v1 - firestore_v1beta1 - fitness_v1 - jobs_v3p1beta1 - serviceconsumermanagement_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - slides_v1 - youtube_partner_v1
2019-01-11 00:36:34 +00:00
# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
# methods.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] google_cloud_dialogflow_v2_intent_object
# @param [String] intent_view
# Optional. The resource view to apply to the returned intent.
# @param [String] language_code
# Optional. The language of training phrases, parameters and rich messages
# defined in `intent`. If not specified, the agent's default language is
# used. [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param [String] update_mask
# Optional. The mask to control which fields get updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_agent_intent(name, google_cloud_dialogflow_v2_intent_object = nil, intent_view: nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2/{+name}', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
command.request_object = google_cloud_dialogflow_v2_intent_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
command.params['name'] = name unless name.nil?
command.query['intentView'] = intent_view unless intent_view.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes all active contexts in the specified session.
# @param [String] parent
# Required. The name of the session to delete all contexts from. Format:
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# `projects/<Project ID>/agent/sessions/<Session ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_agent_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+parent}/contexts', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Processes a natural language query and returns structured, actionable data
# as a result. This method is not idempotent, because it may cause contexts
# and session entity types to be updated, which in turn might affect
# results of future queries.
# @param [String] session
# Required. The name of the session this query is sent to. Format:
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# `projects/<Project ID>/agent/sessions/<Session ID>`. It's up to the API
# caller to choose an appropriate session ID. It can be a random number or
# some type of user identifier (preferably hashed). The length of the session
# ID must not exceed 36 bytes.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentRequest] google_cloud_dialogflow_v2_detect_intent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def detect_project_agent_session_intent(session, google_cloud_dialogflow_v2_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+session}:detectIntent', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentRequest::Representation
command.request_object = google_cloud_dialogflow_v2_detect_intent_request_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse
command.params['session'] = session unless session.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a context.
Autogenerated update (2018-10-12) Update: - content_v2 - dialogflow_v2 - dialogflow_v2beta1 - monitoring_v3 - tpu_v1 - tpu_v1alpha1
2018-10-12 00:36:22 +00:00
# If the specified context already exists, overrides the context.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The session to create a context for.
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] google_cloud_dialogflow_v2_context_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_agent_session_context(parent, google_cloud_dialogflow_v2_context_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/contexts', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
command.request_object = google_cloud_dialogflow_v2_context_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified context.
# @param [String] name
# Required. The name of the context to delete. Format:
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified context.
# @param [String] name
# Required. The name of the context. Format:
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the list of all contexts in the specified session.
# @param [String] parent
# Required. The session to list all contexts from.
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Fixnum] page_size
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param [String] page_token
# Optional. The next_page_token value returned from a previous list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_agent_session_contexts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+parent}/contexts', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified context.
# @param [String] name
# Required. The unique identifier of the context. Format:
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
Autogenerated update (2018-11-11) Update: - cloudkms_v1 - dialogflow_v2 - pubsub_v1
2018-11-11 00:36:53 +00:00
# The `Context ID` is always converted to lowercase, may only contain
# characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] google_cloud_dialogflow_v2_context_object
# @param [String] update_mask
# Optional. The mask to control which fields get updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_agent_session_context(name, google_cloud_dialogflow_v2_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2/{+name}', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
command.request_object = google_cloud_dialogflow_v2_context_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a session entity type.
Autogenerated update (2018-10-12) Update: - content_v2 - dialogflow_v2 - dialogflow_v2beta1 - monitoring_v3 - tpu_v1 - tpu_v1alpha1
2018-10-12 00:36:22 +00:00
# If the specified session entity type already exists, overrides the session
# entity type.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] parent
# Required. The session to create a session entity type for.
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] google_cloud_dialogflow_v2_session_entity_type_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_agent_session_entity_type(parent, google_cloud_dialogflow_v2_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/{+parent}/entityTypes', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
command.request_object = google_cloud_dialogflow_v2_session_entity_type_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified session entity type.
# @param [String] name
# Required. The name of the entity type to delete. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Display Name>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified session entity type.
# @param [String] name
# Required. The name of the session entity type. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Display Name>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the list of all session entity types in the specified session.
# @param [String] parent
# Required. The session to list all session entity types from.
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Fixnum] page_size
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param [String] page_token
# Optional. The next_page_token value returned from a previous list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+parent}/entityTypes', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified session entity type.
# @param [String] name
# Required. The unique identifier of this session entity type. Format:
# `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
Autogenerated update (2018-03-29) Update: - androidpublisher_v2 - calendar_v3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - ml_v1
2018-03-29 00:36:15 +00:00
# Display Name>`.
Autogenerated update (2018-10-12) Update: - content_v2 - dialogflow_v2 - dialogflow_v2beta1 - monitoring_v3 - tpu_v1 - tpu_v1alpha1
2018-10-12 00:36:22 +00:00
# `<Entity Type Display Name>` must be the display name of an existing entity
# type in the same agent that will be overridden or supplemented.
Autogenerated update (2018-03-21) Update: - admin_directory_v1 - bigquerydatatransfer_v1 - chat_v1 - content_v2 - content_v2sandbox - dns_v1beta2 - dns_v2beta1 - sqladmin_v1beta4 - storagetransfer_v1
2018-03-21 00:35:33 +00:00
# @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] google_cloud_dialogflow_v2_session_entity_type_object
# @param [String] update_mask
# Optional. The mask to control which fields get updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_agent_session_entity_type(name, google_cloud_dialogflow_v2_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2/{+name}', options)
command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
command.request_object = google_cloud_dialogflow_v2_session_entity_type_object
command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the latest state of a long-running operation. Clients can use this
# method to poll the operation result at intervals as recommended by the API
# service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end