chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: Automated regeneration of dialogflow v2beta1 client (#1617) 

This PR was generated using Autosynth. 🌈


<details><summary>Log from Synthtool</summary>

```
2020-12-03 02:14:31,209 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-dialogflow-v2beta1
nothing to commit, working tree clean
2020-12-03 02:14:31,240 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dialogflow v2beta1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dialogflow v2beta1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.8
Installing tzinfo 1.2.8
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.50.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.20.1
Installing parallel 1.20.1
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.3
Installing powerpack 0.1.3
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:

HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.

If you are upgrading your Rails application from an older version of Rails:

Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.

If you are starting a NEW Rails application, you can ignore this notice.

For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0

Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=dialogflow.v2beta1 --names-out=/workspace/api_names_out.yaml
Loading dialogflow, version v2beta1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/dialogflow.v2beta1.json
    conflict  google/apis/dialogflow_v2beta1.rb
<logflow_v2beta1.rb? (enter "h" for help) [Ynaqdhm] a
       force  google/apis/dialogflow_v2beta1.rb
    conflict  google/apis/dialogflow_v2beta1/service.rb
       force  google/apis/dialogflow_v2beta1/service.rb
    conflict  google/apis/dialogflow_v2beta1/classes.rb
       force  google/apis/dialogflow_v2beta1/classes.rb
    conflict  google/apis/dialogflow_v2beta1/representations.rb
       force  google/apis/dialogflow_v2beta1/representations.rb
    conflict  /workspace/api_names_out.yaml
       force  /workspace/api_names_out.yaml
2020-12-03 02:14:58,081 synthtool [DEBUG] > Wrote metadata to generated/google/apis/dialogflow_v2beta1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/dialogflow_v2beta1/synth.metadata.

```
</details>

Full log will be available here:
https://source.cloud.google.com/results/invocations/7b006b37-fae5-4e1c-9d57-231db3ac031c/targets

- [ ] To automatically regenerate this PR, check this box.
This commit is contained in:
Yoshi Automation Bot 2020-12-03 02:28:02 -08:00 committed by GitHub
parent 7cf64c74da
commit 7a10356fcf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 524 additions and 980 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
api_names_out.yaml
View File

@ -89860,6 +89860,38 @@
"/dialogflow:v2beta1/dialogflow.projects.locations.deleteAgent/parent": parent
"/dialogflow:v2beta1/dialogflow.projects.locations.getAgent": get_project_location_agent
"/dialogflow:v2beta1/dialogflow.projects.locations.getAgent/parent": parent
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.create": create_project_location_knowledge_basis
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.create/parent": parent
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.delete": delete_project_location_knowledge_basis
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.delete/force": force
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.delete/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.create": create_project_location_knowledge_basis_document
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.create/importGcsCustomMetadata": import_gcs_custom_metadata
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.create/parent": parent
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.delete": delete_project_location_knowledge_basis_document
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.delete/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.get": get_project_location_knowledge_basis_document
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.get/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.list": list_project_location_knowledge_basis_documents
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.list/filter": filter
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.list/pageSize": page_size
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.list/pageToken": page_token
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.list/parent": parent
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.patch": patch_project_location_knowledge_basis_document
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.patch/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.patch/updateMask": update_mask
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.reload": reload_project_location_knowledge_basis_document
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.documents.reload/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.get": get_project_location_knowledge_basis
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.get/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.list": list_project_location_knowledge_bases
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.list/filter": filter
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.list/pageSize": page_size
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.list/pageToken": page_token
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.list/parent": parent
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.patch": patch_project_location_knowledge_basis
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.patch/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.knowledgeBases.patch/updateMask": update_mask
"/dialogflow:v2beta1/dialogflow.projects.locations.operations.cancel": cancel_project_location_operation
"/dialogflow:v2beta1/dialogflow.projects.locations.operations.cancel/name": name
"/dialogflow:v2beta1/dialogflow.projects.locations.operations.get": get_project_location_operation

2
generated/google/apis/dialogflow_v2beta1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow/
module DialogflowV2beta1
VERSION = 'V2beta1'
REVISION = '20201116'
REVISION = '20201201'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

653
generated/google/apis/dialogflow_v2beta1/classes.rb
View File

@ -22,651 +22,6 @@ module Google
module Apis
module DialogflowV2beta1
# Represents page information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3PageInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Ignored for WebhookResponse. The unique
# identifier of the current page. Format: `projects//locations//agents//flows//
# pages/`.
# Corresponds to the JSON property `currentPage`
# @return [String]
attr_accessor :current_page
# Represents form information.
# Corresponds to the JSON property `formInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfo]
attr_accessor :form_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@current_page = args[:current_page] if args.key?(:current_page)
@form_info = args[:form_info] if args.key?(:form_info)
end
end
# Represents form information.
class GoogleCloudDialogflowCxV3PageInfoFormInfo
include Google::Apis::Core::Hashable
# Optional for both WebhookRequest and WebhookResponse. The parameters contained
# in the form. Note that the webhook cannot add or remove any form parameter.
# Corresponds to the JSON property `parameterInfo`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo>]
attr_accessor :parameter_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameter_info = args[:parameter_info] if args.key?(:parameter_info)
end
end
# Represents parameter information.
class GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Required for WebhookResponse. The human-
# readable name of the parameter, unique within the form. This field cannot be
# modified by the webhook.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the
# parameter value was just collected on the last conversation turn.
# Corresponds to the JSON property `justCollected`
# @return [Boolean]
attr_accessor :just_collected
alias_method :just_collected?, :just_collected
# Optional for both WebhookRequest and WebhookResponse. Indicates whether the
# parameter is required. Optional parameters will not trigger prompts; however,
# they are filled if the user specifies them. Required parameters must be filled
# before form filling concludes.
# Corresponds to the JSON property `required`
# @return [Boolean]
attr_accessor :required
alias_method :required?, :required
# Always present for WebhookRequest. Required for WebhookResponse. The state of
# the parameter. This field can be set to INVALID by the webhook to invalidate
# the parameter; other values set by the webhook will be ignored.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Optional for both WebhookRequest and WebhookResponse. The value of the
# parameter. This field can be set by the webhook to change the parameter value.
# Corresponds to the JSON property `value`
# @return [Object]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@just_collected = args[:just_collected] if args.key?(:just_collected)
@required = args[:required] if args.key?(:required)
@state = args[:state] if args.key?(:state)
@value = args[:value] if args.key?(:value)
end
end
# Represents a response message that can be returned by a conversational agent.
# Response messages are also used for output audio synthesis. The approach is as
# follows: * If at least one OutputAudioText response is present, then all
# OutputAudioText responses are linearly concatenated, and the result is used
# for output audio synthesis. * If the OutputAudioText responses are a mixture
# of text and SSML, then the concatenated result is treated as SSML; otherwise,
# the result is treated as either text or SSML as appropriate. The agent
# designer should ideally use either text or SSML consistently throughout the
# bot design. * Otherwise, all Text responses are linearly concatenated, and the
# result is used for output audio synthesis. This approach allows for more
# sophisticated user experience scenarios, where the text displayed to the user
# may differ from what is heard.
class GoogleCloudDialogflowCxV3ResponseMessage
include Google::Apis::Core::Hashable
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about. Dialogflow only uses this to determine
# which conversations should be counted as successful and doesn't process the
# metadata in this message in any way. Note that Dialogflow also considers
# conversations that get to the conversation end page as successful even if they
# don't return ConversationSuccess. You may set this, for example: * In the
# entry_fulfillment of a Page if entering the page indicates that the
# conversation succeeded. * In a webhook response when you determine that you
# handled the customer issue.
# Corresponds to the JSON property `conversationSuccess`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess]
attr_accessor :conversation_success
# Indicates that interaction with the Dialogflow agent has ended. This message
# is generated by Dialogflow only and not supposed to be defined by the user.
# Corresponds to the JSON property `endInteraction`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction]
attr_accessor :end_interaction
# Indicates that the conversation should be handed off to a live agent.
# Dialogflow only uses this to determine which conversations were handed off to
# a human agent for measurement purposes. What else to do with this signal is up
# to you and your handoff procedures. You may set this, for example: * In the
# entry_fulfillment of a Page if entering the page indicates something went
# extremely wrong in the conversation. * In a webhook response when you
# determine that the customer issue can only be handled by a human.
# Corresponds to the JSON property `liveAgentHandoff`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff]
attr_accessor :live_agent_handoff
# Represents an audio message that is composed of both segments synthesized from
# the Dialogflow agent prompts and ones hosted externally at the specified URIs.
# The external URIs are specified via play_audio. This message is generated by
# Dialogflow only and not supposed to be defined by the user.
# Corresponds to the JSON property `mixedAudio`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio]
attr_accessor :mixed_audio
# A text or ssml response that is preferentially used for TTS output audio
# synthesis, as described in the comment on the ResponseMessage message.
# Corresponds to the JSON property `outputAudioText`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText]
attr_accessor :output_audio_text
# Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Specifies an audio clip to be played by the client as part of the response.
# Corresponds to the JSON property `playAudio`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio]
attr_accessor :play_audio
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageText]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@conversation_success = args[:conversation_success] if args.key?(:conversation_success)
@end_interaction = args[:end_interaction] if args.key?(:end_interaction)
@live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
@mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio)
@output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
@payload = args[:payload] if args.key?(:payload)
@play_audio = args[:play_audio] if args.key?(:play_audio)
@text = args[:text] if args.key?(:text)
end
end
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about. Dialogflow only uses this to determine
# which conversations should be counted as successful and doesn't process the
# metadata in this message in any way. Note that Dialogflow also considers
# conversations that get to the conversation end page as successful even if they
# don't return ConversationSuccess. You may set this, for example: * In the
# entry_fulfillment of a Page if entering the page indicates that the
# conversation succeeded. * In a webhook response when you determine that you
# handled the customer issue.
class GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
include Google::Apis::Core::Hashable
# Custom metadata. Dialogflow doesn't impose any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Indicates that interaction with the Dialogflow agent has ended. This message
# is generated by Dialogflow only and not supposed to be defined by the user.
class GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Indicates that the conversation should be handed off to a live agent.
# Dialogflow only uses this to determine which conversations were handed off to
# a human agent for measurement purposes. What else to do with this signal is up
# to you and your handoff procedures. You may set this, for example: * In the
# entry_fulfillment of a Page if entering the page indicates something went
# extremely wrong in the conversation. * In a webhook response when you
# determine that the customer issue can only be handled by a human.
class GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose any
# structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Represents an audio message that is composed of both segments synthesized from
# the Dialogflow agent prompts and ones hosted externally at the specified URIs.
# The external URIs are specified via play_audio. This message is generated by
# Dialogflow only and not supposed to be defined by the user.
class GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
include Google::Apis::Core::Hashable
# Segments this audio response is composed of.
# Corresponds to the JSON property `segments`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment>]
attr_accessor :segments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@segments = args[:segments] if args.key?(:segments)
end
end
# Represents one segment of audio.
class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment
include Google::Apis::Core::Hashable
# Output only. Whether the playback of this segment can be interrupted by the
# end user's speech and the client should then start the next Dialogflow request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Raw audio synthesized from the Dialogflow agent's response using the output
# config specified in the request.
# Corresponds to the JSON property `audio`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :audio
# Client-specific URI that points to an audio clip accessible to the client.
# Dialogflow does not impose any validation on it.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@audio = args[:audio] if args.key?(:audio)
@uri = args[:uri] if args.key?(:uri)
end
end
# A text or ssml response that is preferentially used for TTS output audio
# synthesis, as described in the comment on the ResponseMessage message.
class GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
include Google::Apis::Core::Hashable
# Output only. Whether the playback of this message can be interrupted by the
# end user's speech and the client can then starts the next Dialogflow request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# The SSML text to be synthesized. For more information, see [SSML](/speech/text-
# to-speech/docs/ssml).
# Corresponds to the JSON property `ssml`
# @return [String]
attr_accessor :ssml
# The raw text to be synthesized.
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@ssml = args[:ssml] if args.key?(:ssml)
@text = args[:text] if args.key?(:text)
end
end
# Specifies an audio clip to be played by the client as part of the response.
class GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
include Google::Apis::Core::Hashable
# Output only. Whether the playback of this message can be interrupted by the
# end user's speech and the client can then starts the next Dialogflow request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Required. URI of the audio clip. Dialogflow does not impose any validation on
# this value. It is specific to the client that reads it.
# Corresponds to the JSON property `audioUri`
# @return [String]
attr_accessor :audio_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@audio_uri = args[:audio_uri] if args.key?(:audio_uri)
end
end
# The text response message.
class GoogleCloudDialogflowCxV3ResponseMessageText
include Google::Apis::Core::Hashable
# Output only. Whether the playback of this message can be interrupted by the
# end user's speech and the client can then starts the next Dialogflow request.
# Corresponds to the JSON property `allowPlaybackInterruption`
# @return [Boolean]
attr_accessor :allow_playback_interruption
alias_method :allow_playback_interruption?, :allow_playback_interruption
# Required. A collection of text responses.
# Corresponds to the JSON property `text`
# @return [Array<String>]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
@text = args[:text] if args.key?(:text)
end
end
# Represents session information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3SessionInfo
include Google::Apis::Core::Hashable
# Optional for WebhookRequest. Optional for WebhookResponse. All parameters
# collected from forms and intents during the session. Parameters can be created,
# updated, or removed by the webhook. To remove a parameter from the session,
# the webhook should explicitly set the parameter value to null in
# WebhookResponse. The map is keyed by parameters' display names.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Object>]
attr_accessor :parameters
# Always present for WebhookRequest. Ignored for WebhookResponse. The unique
# identifier of the session. This field can be used by the webhook to identify a
# user. Format: `projects//locations//agents//sessions/`.
# Corresponds to the JSON property `session`
# @return [String]
attr_accessor :session
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameters = args[:parameters] if args.key?(:parameters)
@session = args[:session] if args.key?(:session)
end
end
# The request message for a webhook call.
class GoogleCloudDialogflowCxV3WebhookRequest
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the DetectIntentResponse that will be
# returned to the API caller.
# Corresponds to the JSON property `detectIntentResponseId`
# @return [String]
attr_accessor :detect_intent_response_id
# Represents fulfillment information communicated to the webhook.
# Corresponds to the JSON property `fulfillmentInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo]
attr_accessor :fulfillment_info
# Represents intent information communicated to the webhook.
# Corresponds to the JSON property `intentInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo]
attr_accessor :intent_info
# The list of rich message responses to present to the user. Webhook can choose
# to append or replace this list in WebhookResponse.fulfillment_response;
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessage>]
attr_accessor :messages
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfo]
attr_accessor :page_info
# Custom data set in QueryParameters.payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3SessionInfo]
attr_accessor :session_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id)
@fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
@intent_info = args[:intent_info] if args.key?(:intent_info)
@messages = args[:messages] if args.key?(:messages)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
end
end
# Represents fulfillment information communicated to the webhook.
class GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo
include Google::Apis::Core::Hashable
# Always present. The tag used to identify which fulfillment is being called.
# Corresponds to the JSON property `tag`
# @return [String]
attr_accessor :tag
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@tag = args[:tag] if args.key?(:tag)
end
end
# Represents intent information communicated to the webhook.
class GoogleCloudDialogflowCxV3WebhookRequestIntentInfo
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the last matched intent. Format: `
# projects//locations//agents//intents/`.
# Corresponds to the JSON property `lastMatchedIntent`
# @return [String]
attr_accessor :last_matched_intent
# Parameters identified as a result of intent matching. This is a map of the
# name of the identified parameter to the value of the parameter identified from
# the user's utterance. All parameters defined in the matched intent that are
# identified will be surfaced here.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue>]
attr_accessor :parameters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@last_matched_intent = args[:last_matched_intent] if args.key?(:last_matched_intent)
@parameters = args[:parameters] if args.key?(:parameters)
end
end
# Represents a value for an intent parameter.
class GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue
include Google::Apis::Core::Hashable
# Always present. Original text value extracted from user utterance.
# Corresponds to the JSON property `originalValue`
# @return [String]
attr_accessor :original_value
# Always present. Structured value for the parameter extracted from user
# utterance.
# Corresponds to the JSON property `resolvedValue`
# @return [Object]
attr_accessor :resolved_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@original_value = args[:original_value] if args.key?(:original_value)
@resolved_value = args[:resolved_value] if args.key?(:resolved_value)
end
end
# The response message for a webhook call.
class GoogleCloudDialogflowCxV3WebhookResponse
include Google::Apis::Core::Hashable
# Represents a fulfillment response to the user.
# Corresponds to the JSON property `fulfillmentResponse`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse]
attr_accessor :fulfillment_response
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfo]
attr_accessor :page_info
# Value to append directly to QueryResult.webhook_payloads.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3SessionInfo]
attr_accessor :session_info
# The target flow to transition to. Format: `projects//locations//agents//flows/`
# .
# Corresponds to the JSON property `targetFlow`
# @return [String]
attr_accessor :target_flow
# The target page to transition to. Format: `projects//locations//agents//flows//
# pages/`.
# Corresponds to the JSON property `targetPage`
# @return [String]
attr_accessor :target_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fulfillment_response = args[:fulfillment_response] if args.key?(:fulfillment_response)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
@target_flow = args[:target_flow] if args.key?(:target_flow)
@target_page = args[:target_page] if args.key?(:target_page)
end
end
# Represents a fulfillment response to the user.
class GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse
include Google::Apis::Core::Hashable
# Merge behavior for `messages`.
# Corresponds to the JSON property `mergeBehavior`
# @return [String]
attr_accessor :merge_behavior
# The list of rich message responses to present to the user.
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessage>]
attr_accessor :messages
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@merge_behavior = args[:merge_behavior] if args.key?(:merge_behavior)
@messages = args[:messages] if args.key?(:messages)
end
end
# Metadata associated with the long running operation for Versions.CreateVersion.
class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata
include Google::Apis::Core::Hashable
@ -2958,8 +2313,8 @@ module Google
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2MessageAnnotation]
attr_accessor :message_annotation
# The unique identifier of the message. Format: `projects//conversations//
# messages/`.
# The unique identifier of the message. Format: `projects//locations//
# conversations//messages/`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -4052,7 +3407,7 @@ module Google
attr_accessor :mime_type
# Optional. The document resource name. The name must be empty when creating a
# document. Format: `projects//knowledgeBases//documents/`.
# document. Format: `projects//locations//knowledgeBases//documents/`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -6478,7 +5833,7 @@ module Google
attr_accessor :language_code
# The knowledge base resource name. The name must be empty when creating a
# knowledge base. Format: `projects//knowledgeBases/`.
# knowledge base. Format: `projects//locations//knowledgeBases/`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name

299
generated/google/apis/dialogflow_v2beta1/representations.rb
View File

@ -22,120 +22,6 @@ module Google
module Apis
module DialogflowV2beta1
class GoogleCloudDialogflowCxV3PageInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3PageInfoFormInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3ResponseMessageText
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3SessionInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3WebhookRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3WebhookRequestIntentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3WebhookResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -1252,191 +1138,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3PageInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :current_page, as: 'currentPage'
property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfo::Representation
end
end
class GoogleCloudDialogflowCxV3PageInfoFormInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameter_info, as: 'parameterInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo::Representation
end
end
class GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :just_collected, as: 'justCollected'
property :required, as: 'required'
property :state, as: 'state'
property :value, as: 'value'
end
end
class GoogleCloudDialogflowCxV3ResponseMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess::Representation
property :end_interaction, as: 'endInteraction', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction::Representation
property :live_agent_handoff, as: 'liveAgentHandoff', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff::Representation
property :mixed_audio, as: 'mixedAudio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio::Representation
property :output_audio_text, as: 'outputAudioText', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText::Representation
hash :payload, as: 'payload'
property :play_audio, as: 'playAudio', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio::Representation
property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageText, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageText::Representation
end
end
class GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :segments, as: 'segments', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment::Representation
end
end
class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :audio, :base64 => true, as: 'audio'
property :uri, as: 'uri'
end
end
class GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :ssml, as: 'ssml'
property :text, as: 'text'
end
end
class GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
property :audio_uri, as: 'audioUri'
end
end
class GoogleCloudDialogflowCxV3ResponseMessageText
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :allow_playback_interruption, as: 'allowPlaybackInterruption'
collection :text, as: 'text'
end
end
class GoogleCloudDialogflowCxV3SessionInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :parameters, as: 'parameters'
property :session, as: 'session'
end
end
class GoogleCloudDialogflowCxV3WebhookRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :detect_intent_response_id, as: 'detectIntentResponseId'
property :fulfillment_info, as: 'fulfillmentInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo::Representation
property :intent_info, as: 'intentInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo::Representation
collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessage, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessage::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3SessionInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3SessionInfo::Representation
end
end
class GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :tag, as: 'tag'
end
end
class GoogleCloudDialogflowCxV3WebhookRequestIntentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :last_matched_intent, as: 'lastMatchedIntent'
hash :parameters, as: 'parameters', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue::Representation
end
end
class GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :original_value, as: 'originalValue'
property :resolved_value, as: 'resolvedValue'
end
end
class GoogleCloudDialogflowCxV3WebhookResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :fulfillment_response, as: 'fulfillmentResponse', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3SessionInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3SessionInfo::Representation
property :target_flow, as: 'targetFlow'
property :target_page, as: 'targetPage'
end
end
class GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :merge_behavior, as: 'mergeBehavior'
collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessage, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3ResponseMessage::Representation
end
end
class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation

516
generated/google/apis/dialogflow_v2beta1/service.rb
View File

@ -894,7 +894,9 @@ module Google
# 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.
# future queries. Note: Always use agent versions for production traffic. See [
# Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
# versions).
# @param [String] session
# Required. The name of the session this query is sent to. Supported formats: - `
# projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@ -906,7 +908,9 @@ module Google
# can be a random number or some type of user and session identifiers (
# preferably hashed). The length of the `Session ID` and `User ID` must not
# exceed 36 characters. For more information, see the [API interactions guide](
# https://cloud.google.com/dialogflow/docs/api-overview).
# https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent
# versions for production traffic. See [Versions and environments](https://cloud.
# google.com/dialogflow/es/docs/agents-versions).
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1621,7 +1625,8 @@ module Google
# Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource
# is deprecated; only use `projects.knowledgeBases`.
# @param [String] parent
# Required. The project to create a knowledge base for. Format: `projects/`.
# Required. The project to create a knowledge base for. Format: `projects//
# locations/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1656,7 +1661,7 @@ module Google
# resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# Required. The name of the knowledge base to delete. Format: `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [Boolean] force
# Optional. Force deletes the knowledge base. When set to true, any documents in
# the knowledge base are also deleted.
@ -1692,7 +1697,7 @@ module Google
# knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# Required. The name of the knowledge base to retrieve. Format `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1724,7 +1729,8 @@ module Google
# projects.agent.knowledgeBases` resource is deprecated; only use `projects.
# knowledgeBases`.
# @param [String] parent
# Required. The project to list of knowledge bases for. Format: `projects/`.
# Required. The project to list of knowledge bases for. Format: `projects//
# locations/`.
# @param [String] filter
# The filter expression used to filter knowledge bases returned by the list
# method. The expression has the following syntax: [AND ] ... The following
@ -1777,7 +1783,7 @@ module Google
# resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# The knowledge base resource name. The name must be empty when creating a
# knowledge base. Format: `projects//knowledgeBases/`.
# knowledge base. Format: `projects//locations//knowledgeBases/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object
# @param [String] update_mask
# Optional. Not specified means `update all`. Currently, only `display_name` can
@ -1817,7 +1823,7 @@ module Google
# resource is deprecated; only use `projects.knowledgeBases.documents`.
# @param [String] parent
# Required. The knowledge base to create a document for. Format: `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object
# @param [Boolean] import_gcs_custom_metadata
# Whether to import custom metadata from Google Cloud Storage. Only valid when
@ -1856,7 +1862,7 @@ module Google
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to delete. Format: `projects//
# Required. The name of the document to delete. Format: `projects//locations//
# knowledgeBases//documents/`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1889,7 +1895,7 @@ module Google
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to retrieve. Format `projects//
# Required. The name of the document to retrieve. Format `projects//locations//
# knowledgeBases//documents/`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1923,7 +1929,7 @@ module Google
# knowledgeBases.documents`.
# @param [String] parent
# Required. The knowledge base to list all documents for. Format: `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [String] filter
# The filter expression used to filter documents returned by the list method.
# The expression has the following syntax: [AND ] ... The following fields and
@ -1974,7 +1980,7 @@ module Google
# .
# @param [String] name
# Optional. The document resource name. The name must be empty when creating a
# document. Format: `projects//knowledgeBases//documents/`.
# document. Format: `projects//locations//knowledgeBases//documents/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object
# @param [String] update_mask
# Optional. Not specified means `update all`. Currently, only `display_name` can
@ -2020,7 +2026,7 @@ module Google
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to reload. Format: `projects//
# Required. The name of the document to reload. Format: `projects//locations//
# knowledgeBases//documents/`
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_request_object
# @param [String] fields
@ -2091,7 +2097,9 @@ module Google
# 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.
# future queries. Note: Always use agent versions for production traffic. See [
# Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
# versions).
# @param [String] session
# Required. The name of the session this query is sent to. Supported formats: - `
# projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@ -2103,7 +2111,9 @@ module Google
# can be a random number or some type of user and session identifiers (
# preferably hashed). The length of the `Session ID` and `User ID` must not
# exceed 36 characters. For more information, see the [API interactions guide](
# https://cloud.google.com/dialogflow/docs/api-overview).
# https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent
# versions for production traffic. See [Versions and environments](https://cloud.
# google.com/dialogflow/es/docs/agents-versions).
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -2542,7 +2552,8 @@ module Google
# Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource
# is deprecated; only use `projects.knowledgeBases`.
# @param [String] parent
# Required. The project to create a knowledge base for. Format: `projects/`.
# Required. The project to create a knowledge base for. Format: `projects//
# locations/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -2577,7 +2588,7 @@ module Google
# resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# Required. The name of the knowledge base to delete. Format: `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [Boolean] force
# Optional. Force deletes the knowledge base. When set to true, any documents in
# the knowledge base are also deleted.
@ -2613,7 +2624,7 @@ module Google
# knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# Required. The name of the knowledge base to retrieve. Format `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -2645,7 +2656,8 @@ module Google
# projects.agent.knowledgeBases` resource is deprecated; only use `projects.
# knowledgeBases`.
# @param [String] parent
# Required. The project to list of knowledge bases for. Format: `projects/`.
# Required. The project to list of knowledge bases for. Format: `projects//
# locations/`.
# @param [String] filter
# The filter expression used to filter knowledge bases returned by the list
# method. The expression has the following syntax: [AND ] ... The following
@ -2698,7 +2710,7 @@ module Google
# resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# The knowledge base resource name. The name must be empty when creating a
# knowledge base. Format: `projects//knowledgeBases/`.
# knowledge base. Format: `projects//locations//knowledgeBases/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object
# @param [String] update_mask
# Optional. Not specified means `update all`. Currently, only `display_name` can
@ -2738,7 +2750,7 @@ module Google
# resource is deprecated; only use `projects.knowledgeBases.documents`.
# @param [String] parent
# Required. The knowledge base to create a document for. Format: `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object
# @param [Boolean] import_gcs_custom_metadata
# Whether to import custom metadata from Google Cloud Storage. Only valid when
@ -2777,7 +2789,7 @@ module Google
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to delete. Format: `projects//
# Required. The name of the document to delete. Format: `projects//locations//
# knowledgeBases//documents/`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -2810,7 +2822,7 @@ module Google
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to retrieve. Format `projects//
# Required. The name of the document to retrieve. Format `projects//locations//
# knowledgeBases//documents/`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -2844,7 +2856,7 @@ module Google
# knowledgeBases.documents`.
# @param [String] parent
# Required. The knowledge base to list all documents for. Format: `projects//
# knowledgeBases/`.
# locations//knowledgeBases/`.
# @param [String] filter
# The filter expression used to filter documents returned by the list method.
# The expression has the following syntax: [AND ] ... The following fields and
@ -2895,7 +2907,7 @@ module Google
# .
# @param [String] name
# Optional. The document resource name. The name must be empty when creating a
# document. Format: `projects//knowledgeBases//documents/`.
# document. Format: `projects//locations//knowledgeBases//documents/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object
# @param [String] update_mask
# Optional. Not specified means `update all`. Currently, only `display_name` can
@ -2941,7 +2953,7 @@ module Google
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to reload. Format: `projects//
# Required. The name of the document to reload. Format: `projects//locations//
# knowledgeBases//documents/`
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_request_object
# @param [String] fields
@ -3819,7 +3831,9 @@ module Google
# 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.
# future queries. Note: Always use agent versions for production traffic. See [
# Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
# versions).
# @param [String] session
# Required. The name of the session this query is sent to. Supported formats: - `
# projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@ -3831,7 +3845,9 @@ module Google
# can be a random number or some type of user and session identifiers (
# preferably hashed). The length of the `Session ID` and `User ID` must not
# exceed 36 characters. For more information, see the [API interactions guide](
# https://cloud.google.com/dialogflow/docs/api-overview).
# https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent
# versions for production traffic. See [Versions and environments](https://cloud.
# google.com/dialogflow/es/docs/agents-versions).
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -4582,7 +4598,9 @@ module Google
# 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.
# future queries. Note: Always use agent versions for production traffic. See [
# Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-
# versions).
# @param [String] session
# Required. The name of the session this query is sent to. Supported formats: - `
# projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `
@ -4594,7 +4612,9 @@ module Google
# can be a random number or some type of user and session identifiers (
# preferably hashed). The length of the `Session ID` and `User ID` must not
# exceed 36 characters. For more information, see the [API interactions guide](
# https://cloud.google.com/dialogflow/docs/api-overview).
# https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent
# versions for production traffic. See [Versions and environments](https://cloud.
# google.com/dialogflow/es/docs/agents-versions).
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -5030,6 +5050,442 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource
# is deprecated; only use `projects.knowledgeBases`.
# @param [String] parent
# Required. The project to create a knowledge base for. Format: `projects//
# locations/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase]
#
# @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_location_knowledge_basis(parent, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/{+parent}/knowledgeBases', options)
command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
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 knowledge base. Note: The `projects.agent.knowledgeBases`
# resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# Required. The name of the knowledge base to delete. Format: `projects//
# locations//knowledgeBases/`.
# @param [Boolean] force
# Optional. Force deletes the knowledge base. When set to true, any documents in
# the knowledge base are also deleted.
# @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::DialogflowV2beta1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::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_location_knowledge_basis(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['force'] = force unless force.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 knowledge base. Note: The `projects.agent.
# knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# Required. The name of the knowledge base to retrieve. Format `projects//
# locations//knowledgeBases/`.
# @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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase]
#
# @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_location_knowledge_basis(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
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 knowledge bases of the specified agent. Note: The `
# projects.agent.knowledgeBases` resource is deprecated; only use `projects.
# knowledgeBases`.
# @param [String] parent
# Required. The project to list of knowledge bases for. Format: `projects//
# locations/`.
# @param [String] filter
# The filter expression used to filter knowledge bases returned by the list
# method. The expression has the following syntax: [AND ] ... The following
# fields and operators are supported: * display_name with has(:) operator *
# language_code with equals(=) operator Examples: * 'language_code=en-us'
# matches knowledge bases with en-us language code. * 'display_name:articles'
# matches knowledge bases whose display name contains "articles". * '
# display_name:"Best Articles"' matches knowledge bases whose display name
# contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
# matches all knowledge bases whose display name contains "articles" and whose
# language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
# and will result in no filtering. For more information about filtering, see [
# API Filtering](https://aip.dev/160).
# @param [Fixnum] page_size
# The maximum number of items to return in a single page. By default 10 and at
# most 100.
# @param [String] page_token
# 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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse]
#
# @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_location_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/knowledgeBases', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.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 knowledge base. Note: The `projects.agent.knowledgeBases`
# resource is deprecated; only use `projects.knowledgeBases`.
# @param [String] name
# The knowledge base resource name. The name must be empty when creating a
# knowledge base. Format: `projects//locations//knowledgeBases/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object
# @param [String] update_mask
# Optional. Not specified means `update all`. Currently, only `display_name` can
# be updated, an InvalidArgument will be returned for attempting to update other
# fields.
# @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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase]
#
# @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_location_knowledge_basis(name, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2beta1/{+name}', options)
command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
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 new document. Note: The `projects.agent.knowledgeBases.documents`
# resource is deprecated; only use `projects.knowledgeBases.documents`.
# @param [String] parent
# Required. The knowledge base to create a document for. Format: `projects//
# locations//knowledgeBases/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object
# @param [Boolean] import_gcs_custom_metadata
# Whether to import custom metadata from Google Cloud Storage. Only valid when
# the document source is Google Cloud Storage URI.
# @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::DialogflowV2beta1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::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 create_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/{+parent}/documents', options)
command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
command.request_object = google_cloud_dialogflow_v2beta1_document_object
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['importGcsCustomMetadata'] = import_gcs_custom_metadata unless import_gcs_custom_metadata.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 document. Note: The `projects.agent.knowledgeBases.
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to delete. Format: `projects//locations//
# knowledgeBases//documents/`.
# @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::DialogflowV2beta1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::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 delete_project_location_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2beta1::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
# Retrieves the specified document. Note: The `projects.agent.knowledgeBases.
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to retrieve. Format `projects//locations//
# knowledgeBases//documents/`.
# @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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document]
#
# @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_location_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+name}', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document
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 documents of the knowledge base. Note: The `projects.
# agent.knowledgeBases.documents` resource is deprecated; only use `projects.
# knowledgeBases.documents`.
# @param [String] parent
# Required. The knowledge base to list all documents for. Format: `projects//
# locations//knowledgeBases/`.
# @param [String] filter
# The filter expression used to filter documents returned by the list method.
# The expression has the following syntax: [AND ] ... The following fields and
# operators are supported: * knowledge_types with has(:) operator * display_name
# with has(:) operator * state with equals(=) operator Examples: * "
# knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
# display_name:customer" matches documents whose display name contains "customer"
# . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
# AND state=ACTIVE" matches all active FAQ documents. For more information about
# filtering, see [API Filtering](https://aip.dev/160).
# @param [Fixnum] page_size
# The maximum number of items to return in a single page. By default 10 and at
# most 100.
# @param [String] page_token
# 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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse]
#
# @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_location_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/documents', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.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 document. Note: The `projects.agent.knowledgeBases.
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Optional. The document resource name. The name must be empty when creating a
# document. Format: `projects//locations//knowledgeBases//documents/`.
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object
# @param [String] update_mask
# Optional. Not specified means `update all`. Currently, only `display_name` can
# be updated, an InvalidArgument will be returned for attempting to update other
# fields.
# @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::DialogflowV2beta1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::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 patch_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2beta1/{+name}', options)
command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
command.request_object = google_cloud_dialogflow_v2beta1_document_object
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
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
# Reloads the specified document from its specified source, content_uri or
# content. The previously loaded content of the document will be deleted. Note:
# Even when the content of the document has not changed, there still may be side
# effects because of internal implementation changes. Note: If the document
# source is Google Cloud Storage URI, its metadata will be replaced with the
# custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata`
# field is set to true in the request. Note: The `projects.agent.knowledgeBases.
# documents` resource is deprecated; only use `projects.knowledgeBases.documents`
# .
# @param [String] name
# Required. The name of the document to reload. Format: `projects//locations//
# knowledgeBases//documents/`
# @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_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::DialogflowV2beta1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::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 reload_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/{+name}:reload', options)
command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest::Representation
command.request_object = google_cloud_dialogflow_v2beta1_reload_document_request_object
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DialogflowV2beta1::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
# Starts asynchronous cancellation on a long-running operation. The server makes
# a best effort to cancel the operation, but success is not guaranteed. If the
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

2
generated/google/apis/dialogflow_v2beta1/synth.metadata
View File

@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/google-api-ruby-client.git",
"sha": "fda99a7f81f55342ce6317eeb1430efb3a3049d0"
"sha": "1ca7ec3e2f29bdd2184cd075ab5ad2f60c9109fc"
}
}
]