| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.locations.html">locations</a> . <a href="dialogflow_v2.projects.locations.conversations.html">conversations</a> . <a href="dialogflow_v2.projects.locations.conversations.participants.html">participants</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="dialogflow_v2.projects.locations.conversations.participants.suggestions.html">suggestions()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the suggestions Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#analyzeContent">analyzeContent(participant, body=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#close">close()</a></code></p> |
| 87 | <p class="firstline">Close httplib2 connections.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Creates a new participant in a conversation.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Retrieves a conversation participant.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 96 | <p class="firstline">Returns the list of all participants in the specified conversation.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 99 | <p class="firstline">Retrieves the next page of results.</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Updates the specified participant.</p> |
| 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| 105 | <code class="details" id="analyzeContent">analyzeContent(participant, body=None, x__xgafv=None)</code> |
| 106 | <pre>Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions). |
| 107 | |
| 108 | Args: |
| 109 | participant: string, Required. The name of the participant this text comes from. Format: `projects//locations//conversations//participants/`. (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # The request message for Participants.AnalyzeContent. |
| 114 | "eventInput": { # Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. # An input event to send to Dialogflow. |
| 115 | "languageCode": "A String", # Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| 116 | "name": "A String", # Required. The unique identifier of the event. |
| 117 | "parameters": { # The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 118 | "a_key": "", # Properties of the object. |
| 119 | }, |
| 120 | }, |
| 121 | "queryParams": { # Represents the parameters of the conversational query. # Parameters for a Dialogflow virtual-agent query. |
| 122 | "contexts": [ # The collection of contexts to be activated before this query is executed. |
| 123 | { # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). |
| 124 | "lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. |
| 125 | "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` |
| 126 | "parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 127 | "a_key": "", # Properties of the object. |
| 128 | }, |
| 129 | }, |
| 130 | ], |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 131 | "geoLocation": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 132 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 133 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 134 | }, |
| 135 | "payload": { # This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the `WebhookRequest.original_detect_intent_request.payload` field sent to your webhook. |
| 136 | "a_key": "", # Properties of the object. |
| 137 | }, |
| 138 | "resetContexts": True or False, # Specifies whether to delete all contexts in the current session before the new ones are activated. |
| 139 | "sentimentAnalysisRequestConfig": { # Configures the types of sentiment analysis to perform. # Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. |
| 140 | "analyzeQueryTextSentiment": True or False, # Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`. |
| 141 | }, |
| 142 | "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
| 143 | { # A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| 144 | "entities": [ # Required. The collection of entities associated with this session entity type. |
| 145 | { # An **entity entry** for an associated entity type. |
| 146 | "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. |
| 147 | "A String", |
| 148 | ], |
| 149 | "value": "A String", # Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). |
| 150 | }, |
| 151 | ], |
| 152 | "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
| 153 | "name": "A String", # Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. |
| 154 | }, |
| 155 | ], |
| 156 | "timeZone": "A String", # The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used. |
| 157 | "webhookHeaders": { # This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. |
| 158 | "a_key": "A String", |
| 159 | }, |
| 160 | }, |
| 161 | "replyAudioConfig": { # Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent. # Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled. |
| 162 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| 163 | "sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 164 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized. |
| 165 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 166 | "A String", |
| 167 | ], |
| 168 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 169 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| 170 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 171 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 172 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 173 | }, |
| 174 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| 175 | }, |
| 176 | }, |
| 177 | "requestId": "A String", # A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided. |
| 178 | "textInput": { # Represents the natural language text to be processed. # The natural language text to be processed. |
| 179 | "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| 180 | "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| 181 | }, |
| 182 | } |
| 183 | |
| 184 | x__xgafv: string, V1 error format. |
| 185 | Allowed values |
| 186 | 1 - v1 error format |
| 187 | 2 - v2 error format |
| 188 | |
| 189 | Returns: |
| 190 | An object of the form: |
| 191 | |
| 192 | { # The response message for Participants.AnalyzeContent. |
| 193 | "automatedAgentReply": { # Represents a response from an automated agent. # Only set if a Dialogflow automated agent has responded. Note that: AutomatedAgentReply.detect_intent_response.output_audio and AutomatedAgentReply.detect_intent_response.output_audio_config are always empty, use reply_audio instead. |
| yoshi-code-bot | 7700bbf | 2021-05-20 04:44:03 -0700 | [diff] [blame^] | 194 | "detectIntentResponse": { # The message returned from the DetectIntent method. # Required. Response of the Dialogflow Sessions.DetectIntent call. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 195 | "outputAudio": "A String", # The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. |
| 196 | "outputAudioConfig": { # Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent. # The config used by the speech synthesizer to generate the output audio. |
| 197 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| 198 | "sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 199 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized. |
| 200 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 201 | "A String", |
| 202 | ], |
| 203 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 204 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| 205 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 206 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 207 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 208 | }, |
| 209 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| 210 | }, |
| 211 | }, |
| 212 | "queryResult": { # Represents the result of conversational query or event processing. # The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results. |
| 213 | "action": "A String", # The action name from the matched intent. |
| 214 | "allRequiredParamsPresent": True or False, # This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. |
| 215 | "diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors |
| 216 | "a_key": "", # Properties of the object. |
| 217 | }, |
| 218 | "fulfillmentMessages": [ # The collection of rich messages to present to the user. |
| 219 | { # A rich response message. Corresponds to the intent `Response` field in the Dialogflow console. For more information, see [Rich response messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). |
| 220 | "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google. |
| 221 | "buttons": [ # Optional. The collection of card buttons. |
| 222 | { # The button object that appears at the bottom of a card. |
| 223 | "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button. |
| 224 | "uri": "A String", # Required. The HTTP or HTTPS scheme URI. |
| 225 | }, |
| 226 | "title": "A String", # Required. The title of the button. |
| 227 | }, |
| 228 | ], |
| 229 | "formattedText": "A String", # Required, unless image is present. The body text of the card. |
| 230 | "image": { # The image response message. # Optional. The image for the card. |
| 231 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 232 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 233 | }, |
| 234 | "subtitle": "A String", # Optional. The subtitle of the card. |
| 235 | "title": "A String", # Optional. The title of the card. |
| 236 | }, |
| 237 | "browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google. |
| 238 | "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items. |
| 239 | "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten. |
| 240 | { # Browsing carousel tile |
| 241 | "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text. |
| 242 | "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text. |
| 243 | "image": { # The image response message. # Optional. Hero image for the carousel item. |
| 244 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 245 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 246 | }, |
| 247 | "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user. |
| 248 | "url": "A String", # Required. URL |
| 249 | "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser. |
| 250 | }, |
| 251 | "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text. |
| 252 | }, |
| 253 | ], |
| 254 | }, |
| 255 | "card": { # The card response message. # The card response. |
| 256 | "buttons": [ # Optional. The collection of card buttons. |
| 257 | { # Contains information about a button. |
| 258 | "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open. |
| 259 | "text": "A String", # Optional. The text to show on the button. |
| 260 | }, |
| 261 | ], |
| 262 | "imageUri": "A String", # Optional. The public URI to an image file for the card. |
| 263 | "subtitle": "A String", # Optional. The subtitle of the card. |
| 264 | "title": "A String", # Optional. The title of the card. |
| 265 | }, |
| 266 | "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google. |
| 267 | "items": [ # Required. Carousel items. |
| 268 | { # An item in the carousel. |
| 269 | "description": "A String", # Optional. The body text of the card. |
| 270 | "image": { # The image response message. # Optional. The image to display. |
| 271 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 272 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 273 | }, |
| 274 | "info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item. |
| 275 | "key": "A String", # Required. A unique key that will be sent back to the agent if this response is given. |
| 276 | "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog. |
| 277 | "A String", |
| 278 | ], |
| 279 | }, |
| 280 | "title": "A String", # Required. Title of the carousel item. |
| 281 | }, |
| 282 | ], |
| 283 | }, |
| 284 | "image": { # The image response message. # The image response. |
| 285 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 286 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 287 | }, |
| 288 | "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # The link out suggestion chip for Actions on Google. |
| 289 | "destinationName": "A String", # Required. The name of the app or site this chip is linking to. |
| 290 | "uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip. |
| 291 | }, |
| 292 | "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google. |
| 293 | "items": [ # Required. List items. |
| 294 | { # An item in the list. |
| 295 | "description": "A String", # Optional. The main text describing the item. |
| 296 | "image": { # The image response message. # Optional. The image to display. |
| 297 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 298 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 299 | }, |
| 300 | "info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option. |
| 301 | "key": "A String", # Required. A unique key that will be sent back to the agent if this response is given. |
| 302 | "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog. |
| 303 | "A String", |
| 304 | ], |
| 305 | }, |
| 306 | "title": "A String", # Required. The title of the list item. |
| 307 | }, |
| 308 | ], |
| 309 | "subtitle": "A String", # Optional. Subtitle of the list. |
| 310 | "title": "A String", # Optional. The overall title of the list. |
| 311 | }, |
| 312 | "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google. |
| 313 | "mediaObjects": [ # Required. List of media objects. |
| 314 | { # Response media object for media content card. |
| 315 | "contentUrl": "A String", # Required. Url where the media is stored. |
| 316 | "description": "A String", # Optional. Description of media card. |
| 317 | "icon": { # The image response message. # Optional. Icon to display above media content. |
| 318 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 319 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 320 | }, |
| 321 | "largeImage": { # The image response message. # Optional. Image to display above media content. |
| 322 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 323 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 324 | }, |
| 325 | "name": "A String", # Required. Name of media card. |
| 326 | }, |
| 327 | ], |
| 328 | "mediaType": "A String", # Optional. What type of media is the content (ie "audio"). |
| 329 | }, |
| 330 | "payload": { # A custom platform-specific response. |
| 331 | "a_key": "", # Properties of the object. |
| 332 | }, |
| 333 | "platform": "A String", # Optional. The platform that this message is intended for. |
| 334 | "quickReplies": { # The quick replies response message. # The quick replies response. |
| 335 | "quickReplies": [ # Optional. The collection of quick replies. |
| 336 | "A String", |
| 337 | ], |
| 338 | "title": "A String", # Optional. The title of the collection of quick replies. |
| 339 | }, |
| 340 | "simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # The voice and text-only responses for Actions on Google. |
| 341 | "simpleResponses": [ # Required. The list of simple responses. |
| 342 | { # The simple response message containing speech or text. |
| 343 | "displayText": "A String", # Optional. The text to display. |
| 344 | "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. |
| 345 | "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. |
| 346 | }, |
| 347 | ], |
| 348 | }, |
| 349 | "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google. |
| 350 | "suggestions": [ # Required. The list of suggested replies. |
| 351 | { # The suggestion chip message that the user can tap to quickly post a reply to the conversation. |
| 352 | "title": "A String", # Required. The text shown the in the suggestion chip. |
| 353 | }, |
| 354 | ], |
| 355 | }, |
| 356 | "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google. |
| 357 | "buttons": [ # Optional. List of buttons for the card. |
| 358 | { # The button object that appears at the bottom of a card. |
| 359 | "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button. |
| 360 | "uri": "A String", # Required. The HTTP or HTTPS scheme URI. |
| 361 | }, |
| 362 | "title": "A String", # Required. The title of the button. |
| 363 | }, |
| 364 | ], |
| 365 | "columnProperties": [ # Optional. Display properties for the columns in this table. |
| 366 | { # Column properties for TableCard. |
| 367 | "header": "A String", # Required. Column heading. |
| 368 | "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column. |
| 369 | }, |
| 370 | ], |
| 371 | "image": { # The image response message. # Optional. Image which should be displayed on the card. |
| 372 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 373 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 374 | }, |
| 375 | "rows": [ # Optional. Rows in this table of data. |
| 376 | { # Row of TableCard. |
| 377 | "cells": [ # Optional. List of cells that make up this row. |
| 378 | { # Cell of TableCardRow. |
| 379 | "text": "A String", # Required. Text in this cell. |
| 380 | }, |
| 381 | ], |
| 382 | "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row. |
| 383 | }, |
| 384 | ], |
| 385 | "subtitle": "A String", # Optional. Subtitle to the title. |
| 386 | "title": "A String", # Required. Title of the card. |
| 387 | }, |
| 388 | "text": { # The text response message. # The text response. |
| 389 | "text": [ # Optional. The collection of the agent's responses. |
| 390 | "A String", |
| 391 | ], |
| 392 | }, |
| 393 | }, |
| 394 | ], |
| 395 | "fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. |
| 396 | "intent": { # An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). # The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`. |
| 397 | "action": "A String", # Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. |
| 398 | "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). |
| 399 | "A String", |
| 400 | ], |
| 401 | "displayName": "A String", # Required. The name of this intent. |
| 402 | "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. |
| 403 | "events": [ # Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters. |
| 404 | "A String", |
| 405 | ], |
| 406 | "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. |
| 407 | { # Represents a single followup intent in the chain. |
| 408 | "followupIntentName": "A String", # The unique identifier of the followup intent. Format: `projects//agent/intents/`. |
| 409 | "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`. |
| 410 | }, |
| 411 | ], |
| 412 | "inputContextNames": [ # Optional. The list of context names required for this intent to be triggered. Format: `projects//agent/sessions/-/contexts/`. |
| 413 | "A String", |
| 414 | ], |
| 415 | "isFallback": True or False, # Optional. Indicates whether this is a fallback intent. |
| 416 | "liveAgentHandoff": True or False, # Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false. |
| 417 | "messages": [ # Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. |
| 418 | { # A rich response message. Corresponds to the intent `Response` field in the Dialogflow console. For more information, see [Rich response messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). |
| 419 | "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google. |
| 420 | "buttons": [ # Optional. The collection of card buttons. |
| 421 | { # The button object that appears at the bottom of a card. |
| 422 | "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button. |
| 423 | "uri": "A String", # Required. The HTTP or HTTPS scheme URI. |
| 424 | }, |
| 425 | "title": "A String", # Required. The title of the button. |
| 426 | }, |
| 427 | ], |
| 428 | "formattedText": "A String", # Required, unless image is present. The body text of the card. |
| 429 | "image": { # The image response message. # Optional. The image for the card. |
| 430 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 431 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 432 | }, |
| 433 | "subtitle": "A String", # Optional. The subtitle of the card. |
| 434 | "title": "A String", # Optional. The title of the card. |
| 435 | }, |
| 436 | "browseCarouselCard": { # Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel # Browse carousel card for Actions on Google. |
| 437 | "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in items. |
| 438 | "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten. |
| 439 | { # Browsing carousel tile |
| 440 | "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of text. |
| 441 | "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text. |
| 442 | "image": { # The image response message. # Optional. Hero image for the carousel item. |
| 443 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 444 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 445 | }, |
| 446 | "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user. |
| 447 | "url": "A String", # Required. URL |
| 448 | "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser. |
| 449 | }, |
| 450 | "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text. |
| 451 | }, |
| 452 | ], |
| 453 | }, |
| 454 | "card": { # The card response message. # The card response. |
| 455 | "buttons": [ # Optional. The collection of card buttons. |
| 456 | { # Contains information about a button. |
| 457 | "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to open. |
| 458 | "text": "A String", # Optional. The text to show on the button. |
| 459 | }, |
| 460 | ], |
| 461 | "imageUri": "A String", # Optional. The public URI to an image file for the card. |
| 462 | "subtitle": "A String", # Optional. The subtitle of the card. |
| 463 | "title": "A String", # Optional. The title of the card. |
| 464 | }, |
| 465 | "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google. |
| 466 | "items": [ # Required. Carousel items. |
| 467 | { # An item in the carousel. |
| 468 | "description": "A String", # Optional. The body text of the card. |
| 469 | "image": { # The image response message. # Optional. The image to display. |
| 470 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 471 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 472 | }, |
| 473 | "info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional info about the option item. |
| 474 | "key": "A String", # Required. A unique key that will be sent back to the agent if this response is given. |
| 475 | "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog. |
| 476 | "A String", |
| 477 | ], |
| 478 | }, |
| 479 | "title": "A String", # Required. Title of the carousel item. |
| 480 | }, |
| 481 | ], |
| 482 | }, |
| 483 | "image": { # The image response message. # The image response. |
| 484 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 485 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 486 | }, |
| 487 | "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app or website associated with this agent. # The link out suggestion chip for Actions on Google. |
| 488 | "destinationName": "A String", # Required. The name of the app or site this chip is linking to. |
| 489 | "uri": "A String", # Required. The URI of the app or site to open when the user taps the suggestion chip. |
| 490 | }, |
| 491 | "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google. |
| 492 | "items": [ # Required. List items. |
| 493 | { # An item in the list. |
| 494 | "description": "A String", # Optional. The main text describing the item. |
| 495 | "image": { # The image response message. # Optional. The image to display. |
| 496 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 497 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 498 | }, |
| 499 | "info": { # Additional info about the select item for when it is triggered in a dialog. # Required. Additional information about this option. |
| 500 | "key": "A String", # Required. A unique key that will be sent back to the agent if this response is given. |
| 501 | "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this item in dialog. |
| 502 | "A String", |
| 503 | ], |
| 504 | }, |
| 505 | "title": "A String", # Required. The title of the list item. |
| 506 | }, |
| 507 | ], |
| 508 | "subtitle": "A String", # Optional. Subtitle of the list. |
| 509 | "title": "A String", # Optional. The overall title of the list. |
| 510 | }, |
| 511 | "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google. |
| 512 | "mediaObjects": [ # Required. List of media objects. |
| 513 | { # Response media object for media content card. |
| 514 | "contentUrl": "A String", # Required. Url where the media is stored. |
| 515 | "description": "A String", # Optional. Description of media card. |
| 516 | "icon": { # The image response message. # Optional. Icon to display above media content. |
| 517 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 518 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 519 | }, |
| 520 | "largeImage": { # The image response message. # Optional. Image to display above media content. |
| 521 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 522 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 523 | }, |
| 524 | "name": "A String", # Required. Name of media card. |
| 525 | }, |
| 526 | ], |
| 527 | "mediaType": "A String", # Optional. What type of media is the content (ie "audio"). |
| 528 | }, |
| 529 | "payload": { # A custom platform-specific response. |
| 530 | "a_key": "", # Properties of the object. |
| 531 | }, |
| 532 | "platform": "A String", # Optional. The platform that this message is intended for. |
| 533 | "quickReplies": { # The quick replies response message. # The quick replies response. |
| 534 | "quickReplies": [ # Optional. The collection of quick replies. |
| 535 | "A String", |
| 536 | ], |
| 537 | "title": "A String", # Optional. The title of the collection of quick replies. |
| 538 | }, |
| 539 | "simpleResponses": { # The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. # The voice and text-only responses for Actions on Google. |
| 540 | "simpleResponses": [ # Required. The list of simple responses. |
| 541 | { # The simple response message containing speech or text. |
| 542 | "displayText": "A String", # Optional. The text to display. |
| 543 | "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. |
| 544 | "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. |
| 545 | }, |
| 546 | ], |
| 547 | }, |
| 548 | "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google. |
| 549 | "suggestions": [ # Required. The list of suggested replies. |
| 550 | { # The suggestion chip message that the user can tap to quickly post a reply to the conversation. |
| 551 | "title": "A String", # Required. The text shown the in the suggestion chip. |
| 552 | }, |
| 553 | ], |
| 554 | }, |
| 555 | "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google. |
| 556 | "buttons": [ # Optional. List of buttons for the card. |
| 557 | { # The button object that appears at the bottom of a card. |
| 558 | "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button. |
| 559 | "uri": "A String", # Required. The HTTP or HTTPS scheme URI. |
| 560 | }, |
| 561 | "title": "A String", # Required. The title of the button. |
| 562 | }, |
| 563 | ], |
| 564 | "columnProperties": [ # Optional. Display properties for the columns in this table. |
| 565 | { # Column properties for TableCard. |
| 566 | "header": "A String", # Required. Column heading. |
| 567 | "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column. |
| 568 | }, |
| 569 | ], |
| 570 | "image": { # The image response message. # Optional. Image which should be displayed on the card. |
| 571 | "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
| 572 | "imageUri": "A String", # Optional. The public URI to an image file. |
| 573 | }, |
| 574 | "rows": [ # Optional. Rows in this table of data. |
| 575 | { # Row of TableCard. |
| 576 | "cells": [ # Optional. List of cells that make up this row. |
| 577 | { # Cell of TableCardRow. |
| 578 | "text": "A String", # Required. Text in this cell. |
| 579 | }, |
| 580 | ], |
| 581 | "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row. |
| 582 | }, |
| 583 | ], |
| 584 | "subtitle": "A String", # Optional. Subtitle to the title. |
| 585 | "title": "A String", # Required. Title of the card. |
| 586 | }, |
| 587 | "text": { # The text response message. # The text response. |
| 588 | "text": [ # Optional. The collection of the agent's responses. |
| 589 | "A String", |
| 590 | ], |
| 591 | }, |
| 592 | }, |
| 593 | ], |
| 594 | "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. |
| 595 | "name": "A String", # Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. |
| 596 | "outputContexts": [ # Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`. |
| 597 | { # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). |
| 598 | "lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. |
| 599 | "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` |
| 600 | "parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 601 | "a_key": "", # Properties of the object. |
| 602 | }, |
| 603 | }, |
| 604 | ], |
| 605 | "parameters": [ # Optional. The collection of parameters associated with the intent. |
| 606 | { # Represents intent parameters. |
| 607 | "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. |
| 608 | "displayName": "A String", # Required. The name of the parameter. |
| 609 | "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. |
| 610 | "isList": True or False, # Optional. Indicates whether the parameter represents a list of values. |
| 611 | "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. |
| 612 | "name": "A String", # The unique identifier of this parameter. |
| 613 | "prompts": [ # Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter. |
| 614 | "A String", |
| 615 | ], |
| 616 | "value": "A String", # Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. |
| 617 | }, |
| 618 | ], |
| 619 | "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`. |
| 620 | "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 621 | "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current session when this intent is matched. |
| 622 | "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects//agent/intents/`. |
| 623 | "trainingPhrases": [ # Optional. The collection of examples that the agent is trained on. |
| 624 | { # Represents an example that the agent is trained on. |
| 625 | "name": "A String", # Output only. The unique identifier of this training phrase. |
| 626 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. |
| 627 | { # Represents a part of a training phrase. |
| 628 | "alias": "A String", # Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. |
| 629 | "entityType": "A String", # Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. |
| 630 | "text": "A String", # Required. The text for this part. |
| 631 | "userDefined": True or False, # Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. |
| 632 | }, |
| 633 | ], |
| 634 | "timesAddedCount": 42, # Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. |
| 635 | "type": "A String", # Required. The type of the training phrase. |
| 636 | }, |
| 637 | ], |
| 638 | "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent. |
| 639 | }, |
| 640 | "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. |
| 641 | "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. |
| 642 | "outputContexts": [ # The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query. |
| 643 | { # Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). |
| 644 | "lifespanCount": 42, # Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. |
| 645 | "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` |
| 646 | "parameters": { # Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 647 | "a_key": "", # Properties of the object. |
| 648 | }, |
| 649 | }, |
| 650 | ], |
| 651 | "parameters": { # The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 652 | "a_key": "", # Properties of the object. |
| 653 | }, |
| 654 | "queryText": "A String", # The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input. |
| 655 | "sentimentAnalysisResult": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. |
| 656 | "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. # The sentiment analysis result for `query_text`. |
| 657 | "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |
| 658 | "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
| 659 | }, |
| 660 | }, |
| 661 | "speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. |
| 662 | "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. |
| 663 | "a_key": "", # Properties of the object. |
| 664 | }, |
| 665 | "webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. |
| 666 | }, |
| 667 | "responseId": "A String", # The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
| 668 | "webhookStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Specifies the status of the webhook request. |
| 669 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 670 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 671 | { |
| 672 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 673 | }, |
| 674 | ], |
| 675 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 676 | }, |
| 677 | }, |
| 678 | }, |
| 679 | "dtmfParameters": { # The message in the response that indicates the parameters of DTMF. # Indicates the parameters of DTMF. |
| 680 | "acceptsDtmfInput": True or False, # Indicates whether DTMF input can be handled in the next request. |
| 681 | }, |
| 682 | "endUserSuggestionResults": [ # The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config. |
| 683 | { # One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent. |
| 684 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Error status if the request failed. |
| 685 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 686 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 687 | { |
| 688 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 689 | }, |
| 690 | ], |
| 691 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 692 | }, |
| 693 | "suggestArticlesResponse": { # The response message for Participants.SuggestArticles. # SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. |
| 694 | "articleAnswers": [ # Articles ordered by score in descending order. |
| 695 | { # Represents article answer. |
| 696 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 697 | "confidence": 3.14, # Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 698 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 699 | "a_key": "A String", |
| 700 | }, |
| 701 | "snippets": [ # Article snippets. |
| 702 | "A String", |
| 703 | ], |
| 704 | "title": "A String", # The article title. |
| 705 | "uri": "A String", # The article URI. |
| 706 | }, |
| 707 | ], |
| 708 | "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestArticlesRequest.context_size field in the request if there aren't that many messages in the conversation. |
| 709 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 710 | }, |
| 711 | "suggestFaqAnswersResponse": { # The request message for Participants.SuggestFaqAnswers. # SuggestFaqAnswersResponse if request is for FAQ_ANSWER. |
| 712 | "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size field in the request if there aren't that many messages in the conversation. |
| 713 | "faqAnswers": [ # Answers extracted from FAQ documents. |
| 714 | { # Represents answer from "frequently asked questions". |
| 715 | "answer": "A String", # The piece of text from the `source` knowledge base document. |
| 716 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 717 | "confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 718 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 719 | "a_key": "A String", |
| 720 | }, |
| 721 | "question": "A String", # The corresponding FAQ question. |
| 722 | "source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. |
| 723 | }, |
| 724 | ], |
| 725 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 726 | }, |
| 727 | }, |
| 728 | ], |
| 729 | "humanAgentSuggestionResults": [ # The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config. |
| 730 | { # One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent. |
| 731 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Error status if the request failed. |
| 732 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 733 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 734 | { |
| 735 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 736 | }, |
| 737 | ], |
| 738 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 739 | }, |
| 740 | "suggestArticlesResponse": { # The response message for Participants.SuggestArticles. # SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. |
| 741 | "articleAnswers": [ # Articles ordered by score in descending order. |
| 742 | { # Represents article answer. |
| 743 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 744 | "confidence": 3.14, # Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 745 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 746 | "a_key": "A String", |
| 747 | }, |
| 748 | "snippets": [ # Article snippets. |
| 749 | "A String", |
| 750 | ], |
| 751 | "title": "A String", # The article title. |
| 752 | "uri": "A String", # The article URI. |
| 753 | }, |
| 754 | ], |
| 755 | "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestArticlesRequest.context_size field in the request if there aren't that many messages in the conversation. |
| 756 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 757 | }, |
| 758 | "suggestFaqAnswersResponse": { # The request message for Participants.SuggestFaqAnswers. # SuggestFaqAnswersResponse if request is for FAQ_ANSWER. |
| 759 | "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size field in the request if there aren't that many messages in the conversation. |
| 760 | "faqAnswers": [ # Answers extracted from FAQ documents. |
| 761 | { # Represents answer from "frequently asked questions". |
| 762 | "answer": "A String", # The piece of text from the `source` knowledge base document. |
| 763 | "answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/" |
| 764 | "confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 765 | "metadata": { # A map that contains metadata about the answer and the document from which it originates. |
| 766 | "a_key": "A String", |
| 767 | }, |
| 768 | "question": "A String", # The corresponding FAQ question. |
| 769 | "source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`. |
| 770 | }, |
| 771 | ], |
| 772 | "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. |
| 773 | }, |
| 774 | }, |
| 775 | ], |
| 776 | "message": { # Represents a message posted into a conversation. # Message analyzed by CCAI. |
| 777 | "content": "A String", # Required. The message content. |
| 778 | "createTime": "A String", # Output only. The time when the message was created. |
| 779 | "languageCode": "A String", # Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". |
| 780 | "messageAnnotation": { # Represents the result of annotation for the message. # Output only. The annotation for the message. |
| 781 | "containEntities": True or False, # Indicates whether the text message contains entities. |
| 782 | "parts": [ # The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text]. |
| 783 | { # Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end. |
| 784 | "entityType": "A String", # The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity. |
| 785 | "formattedValue": "", # The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: { "amount": 5, "currency": "USD" } |
| 786 | "text": "A String", # A part of a message possibly annotated with an entity. |
| 787 | }, |
| 788 | ], |
| 789 | }, |
| 790 | "name": "A String", # The unique identifier of the message. Format: `projects//locations//conversations//messages/`. |
| 791 | "participant": "A String", # Output only. The participant that sends this message. |
| 792 | "participantRole": "A String", # Output only. The role of the participant. |
| 793 | }, |
| 794 | "replyAudio": { # Represents the natural language speech audio to be played to the end user. # The audio data bytes encoded as specified in the request. This field is set if: - `reply_audio_config` was specified in the request, or - The automated agent responded with audio to play to the user. In such case, `reply_audio.config` contains settings used to synthesize the speech. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. |
| 795 | "audio": "A String", # The natural language speech audio. |
| 796 | "config": { # Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent. # Instructs the speech synthesizer how to generate the speech audio. |
| 797 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| 798 | "sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 799 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized. |
| 800 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 801 | "A String", |
| 802 | ], |
| 803 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 804 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| 805 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 806 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 807 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 808 | }, |
| 809 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| 810 | }, |
| 811 | }, |
| 812 | }, |
| 813 | "replyText": "A String", # The output text content. This field is set if the automated agent responded with text to show to the user. |
| 814 | }</pre> |
| 815 | </div> |
| 816 | |
| 817 | <div class="method"> |
| 818 | <code class="details" id="close">close()</code> |
| 819 | <pre>Close httplib2 connections.</pre> |
| 820 | </div> |
| 821 | |
| 822 | <div class="method"> |
| 823 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 824 | <pre>Creates a new participant in a conversation. |
| 825 | |
| 826 | Args: |
| 827 | parent: string, Required. Resource identifier of the conversation adding the participant. Format: `projects//locations//conversations/`. (required) |
| 828 | body: object, The request body. |
| 829 | The object takes the form of: |
| 830 | |
| 831 | { # Represents a conversation participant (human agent, virtual agent, end-user). |
| 832 | "name": "A String", # Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. |
| 833 | "role": "A String", # Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
| 834 | "sipRecordingMediaLabel": "A String", # Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. |
| 835 | } |
| 836 | |
| 837 | x__xgafv: string, V1 error format. |
| 838 | Allowed values |
| 839 | 1 - v1 error format |
| 840 | 2 - v2 error format |
| 841 | |
| 842 | Returns: |
| 843 | An object of the form: |
| 844 | |
| 845 | { # Represents a conversation participant (human agent, virtual agent, end-user). |
| 846 | "name": "A String", # Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. |
| 847 | "role": "A String", # Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
| 848 | "sipRecordingMediaLabel": "A String", # Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. |
| 849 | }</pre> |
| 850 | </div> |
| 851 | |
| 852 | <div class="method"> |
| 853 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 854 | <pre>Retrieves a conversation participant. |
| 855 | |
| 856 | Args: |
| 857 | name: string, Required. The name of the participant. Format: `projects//locations//conversations//participants/`. (required) |
| 858 | x__xgafv: string, V1 error format. |
| 859 | Allowed values |
| 860 | 1 - v1 error format |
| 861 | 2 - v2 error format |
| 862 | |
| 863 | Returns: |
| 864 | An object of the form: |
| 865 | |
| 866 | { # Represents a conversation participant (human agent, virtual agent, end-user). |
| 867 | "name": "A String", # Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. |
| 868 | "role": "A String", # Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
| 869 | "sipRecordingMediaLabel": "A String", # Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. |
| 870 | }</pre> |
| 871 | </div> |
| 872 | |
| 873 | <div class="method"> |
| 874 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 875 | <pre>Returns the list of all participants in the specified conversation. |
| 876 | |
| 877 | Args: |
| 878 | parent: string, Required. The conversation to list all participants from. Format: `projects//locations//conversations/`. (required) |
| 879 | pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
| 880 | pageToken: string, Optional. The next_page_token value returned from a previous list request. |
| 881 | x__xgafv: string, V1 error format. |
| 882 | Allowed values |
| 883 | 1 - v1 error format |
| 884 | 2 - v2 error format |
| 885 | |
| 886 | Returns: |
| 887 | An object of the form: |
| 888 | |
| 889 | { # The response message for Participants.ListParticipants. |
| 890 | "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. |
| 891 | "participants": [ # The list of participants. There is a maximum number of items returned based on the page_size field in the request. |
| 892 | { # Represents a conversation participant (human agent, virtual agent, end-user). |
| 893 | "name": "A String", # Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. |
| 894 | "role": "A String", # Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
| 895 | "sipRecordingMediaLabel": "A String", # Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. |
| 896 | }, |
| 897 | ], |
| 898 | }</pre> |
| 899 | </div> |
| 900 | |
| 901 | <div class="method"> |
| 902 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 903 | <pre>Retrieves the next page of results. |
| 904 | |
| 905 | Args: |
| 906 | previous_request: The request for the previous page. (required) |
| 907 | previous_response: The response from the request for the previous page. (required) |
| 908 | |
| 909 | Returns: |
| 910 | A request object that you can call 'execute()' on to request the next |
| 911 | page. Returns None if there are no more items in the collection. |
| 912 | </pre> |
| 913 | </div> |
| 914 | |
| 915 | <div class="method"> |
| 916 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 917 | <pre>Updates the specified participant. |
| 918 | |
| 919 | Args: |
| 920 | name: string, Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. (required) |
| 921 | body: object, The request body. |
| 922 | The object takes the form of: |
| 923 | |
| 924 | { # Represents a conversation participant (human agent, virtual agent, end-user). |
| 925 | "name": "A String", # Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. |
| 926 | "role": "A String", # Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
| 927 | "sipRecordingMediaLabel": "A String", # Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. |
| 928 | } |
| 929 | |
| 930 | updateMask: string, Required. The mask to specify which fields to update. |
| 931 | x__xgafv: string, V1 error format. |
| 932 | Allowed values |
| 933 | 1 - v1 error format |
| 934 | 2 - v2 error format |
| 935 | |
| 936 | Returns: |
| 937 | An object of the form: |
| 938 | |
| 939 | { # Represents a conversation participant (human agent, virtual agent, end-user). |
| 940 | "name": "A String", # Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`. |
| 941 | "role": "A String", # Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
| 942 | "sipRecordingMediaLabel": "A String", # Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. |
| 943 | }</pre> |
| 944 | </div> |
| 945 | |
| 946 | </body></html> |